OasInfo

The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.

Members

Variables

contact
OasContact contact;

The contact information for the exposed API.

description
string description;

A short description of the API. CommonMark syntax MAY be used for rich text representation.

license
OasLicense license;

The license information for the exposed API.

termsOfService
string termsOfService;

A URL to the Terms of Service for the API. MUST be in the format of a URL.

title
string title;

**REQUIRED**. The title of the API.

version_
string version_;

**REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](https://swagger.io/specification/#oas-version) or the API implementation version).

See Also

Meta