Skip to content

Home

Introduction

Development

Overview

IDEs

Services

Service manager

API Explorer

Gloop REST API editor, General tab

The General tab is used to supply general information about the API. The fields here map to the Info Object in the resulting Swagger or OpenAPI definition. The fields in this tab are as follows:

Field Name Description
Version Required. The version of the REST API.
Title Required. The title of the API.
Description A short description of the API. CommonMark syntax may be used for rich text representation.
Terms Of Service A URL to the terms of service for the API. Must be in the format of a URL.
Contact Name The identifying name of the contact person or organization, which will be included in the Swagger or OpenAPI definition.
Contact URL The URL pointing to the contact information. Must be in the format of a URL.
Contact Email The email address of the contact person or organization. Must be in the format of an email address.
License Name Required. The license name used for the API.
License URL A URL to the license used for the API. Must be in the format of a URL.

Gloop REST API editor, General tab

Gloop REST API editor, General tab