Product
This element displays the product details and logo of your product.
Possible Locations
Child Elements
The product details will be displayed only when you provide the <content>.
Attributes
| Name | Type | Description |
|---|---|---|
| name required |
String | Name of the product as configured in the ZSPEC. |
| title | String | Name of the document. This will be displayed at the top of the document once you publish. By default, "{Product_Name} API Documentation" will be displayed. |
| logo-url | String | URL / File path of your logo image. |
| sdk-languages | String (CSV, enum) | List of the programming languages for which ZEST should generate the SDK samples. The possible values are java, nodejs, php, csharp, python and ruby. By default, samples will be generated for all the ZEST supported languages. |
Following are the two possible types of url that you can add to the logo-url attribute.
-
publicly hosted URL
-
base64 encoded image URL
-
Since sdk-languages attribute can be given at multiple levels, it follows this Operation > Resource > Version > Product priority order.
-
The title attribute will behave as a button and displays the product details, only when you provide the
<content>. If it is not provided, it will merely serve as a header of the document.
Example
By default, the product name of ZEST will be picked and will be populated as follows,
copy
<product name="travelbureau" />
You can add the url of the logo that you want to display in the documentation using the attribute logo-url.
copy
<product name="travelbureau" logo-url="https://www.zohowebstatic.com/sites/zweb/images/productlogos/crm.svg" />
Last Updated 2025-05-30 16:54:59 +0530 +0530
Yes
No
Thank you for your feedback!
Send your feedback to us