Info
The info holds the details of your resource, including its version, terms of service, and license information. The version and limit details provided in this element will be used for automation and SDKs.
Possible Locations
Child Elements
- Description required
- Terms of Service
It contains the terms of service of the API. Use Markdown to format your content. - Contact Details
- License Details
Attributes
| Name | Type | Description |
|---|---|---|
| title required |
String | Display label of your resource. |
| version required |
String | Mention the API version. This attribute follows the semantic versioning format - major.minor.patch (e.g., 1.0.0, 2.1, or 3), where the major version is required, and each part is a non-negative integer. |
| limit | Integer | The maximum number of records that can be created in the resource. For example, when you mention limit="100" for a resource, the maximum number of records that can be created in the resource is 100. |
Example
Consider that we are developing a resource called trips using ZEST. It is essential to add the necessary details of the resource such as the title, version and limits to it.
Here are the details of the resource wrapped in the info.
copy
{
<info title="trips" version="4.0" limit="500">
<description>To get the trips data of a travel bureau.</description>
<terms-of-service>This API sternly follows the data usage and privacy policy, API Access Agreement, liability and indemnification. These terms of services are subject to modification and updates.</terms-of-service>
<contact-details name="Travel Bureau Support" email="support@travelbureau.com" url="https://www.travel_bureau.com/resources/support-plans.html" />
<license-details name="Apache License 2" url="https://github.com/googleapis/googleapis/blob/master/LICENSE" />
</info>
}
Since the limit is declared as 500, only 500 records of trip can be created using this trips resource.
Last Updated 2025-05-30 16:54:59 +0530 +0530
Yes
No
Thank you for your feedback!
Send your feedback to us
Skip
Submit