Skip to content

Configuring API General Information

OpenAPI documents include what we call an Info Object which "provides metadata about the API". The values you supply in the plugin's Info tab will be mapped to this object when you generate your OpenAPI document.

Info tab, as seen in the user interface

It's deemed good practice to provide metadata about the API; it gives clients a quick idea of what the API is for and its capabilities. The plugin not only uses this information when generating the OpenAPI schema, it is also used to give clients information about uploaded plugin configurations over the TORO Marketplace.

All fields in the Info tab are required if you intend to share your configuration via the TORO Marketplace. When generating just the OpenAPI document however, the plugin will do its best to auto-generate values for the Info Object if they are not provided in the Info tab.

No options for crawling

The fields in the Info tab cannot be populated by the Crawler. They have to be entered through the plugin's user interface by the user.


Name Required Description Example
Title Yes (for Marketplace uploads) The name of the API. This will also be used to generate a unique Marketplace ID for the plugin configuration/OpenAPI schema. Google Maps Embed API
Description Yes (for Marketplace uploads) A short description of the API. The Google Maps Embed API lets you place an interactive map, or street view panorama on your site with a simple HTTP request.
Version Yes (for Marketplace uploads) The API's version. By default, this is set to 1.0.0-SNAPSHOT. 3.2.3
License Yes (for Marketplace uploads) The API's license type. MIT
Url Yes (for Marketplace uploads) A unique URL that points to the documentation page of the API.