api-morph / InfoObject
Interface: InfoObject
Defined in: src/types/openapi.ts:87
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.
See
https://spec.openapis.org/oas/v3.1.1#info-object
Indexable
[key: `x-${string}`]: any
This object MAY be extended with Specification Extensions.
Properties
contact?
optionalcontact:ContactObject
Defined in: src/types/openapi.ts:111
The contact information for the exposed API.
description?
optionaldescription:string
Defined in: src/types/openapi.ts:101
A description of the API. CommonMark syntax MAY be used for rich text representation.
license?
optionallicense:LicenseObject
Defined in: src/types/openapi.ts:116
The license information for the exposed API.
summary?
optionalsummary:string
Defined in: src/types/openapi.ts:96
A short summary of the API.
termsOfService?
optionaltermsOfService:string
Defined in: src/types/openapi.ts:106
A URI for the Terms of Service for the API. This MUST be in the form of a URI.
title
title:
string
Defined in: src/types/openapi.ts:91
REQUIRED. The title of the API.
version
version:
string
Defined in: src/types/openapi.ts:122
REQUIRED. The version of the OpenAPI Document (which is distinct from the OpenAPI Specification version or the version of the API being described or the version of the OpenAPI Description).