Skip to content

Home

Development

IDEs

JAR services

API Explorer

Gloop REST API editor, Documentation tab

The Documentation tab is used to populate the External Documentation Object of your API's Swagger and OpenAPI definition. The fields in this tab are as follows:

Field Name Description
Generated Documentation URL The URL for the generated documentation of the API.
Documentation URL Required. The URL for the target documentation. Value must be in the format of a URL.
Description A short description of the target documentation. CommonMark syntax may be used for rich text representation.

Gloop REST API editor, Documentation tab

Gloop REST API editor, Documentation tab