api-typescript-generator / Modules / openapi / OpenApiInfo
openapi.OpenApiInfo
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://swagger.io/specification/#info-object
• Optional contact: OpenApiContact
The contact information for the exposed API.
• Optional description: string
A description of the API. CommonMark syntax MAY be used for rich text representation.
• Optional license: OpenApiLicense
The license information for the exposed API.
• Optional summary: string
A short summary of the API.
• Optional termsOfService: string
A URL to the Terms of Service for the API. MUST be in the format of a URL.
• title: string
The title of the API.
• version: string
The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).