api-typescript-generator / Modules / openapi / OpenApiDocument
openapi.OpenApiDocument
OpenAPI 3.1.0 document
See
https://swagger.io/specification/#openapi-object
• Optional components: OpenApiComponents
An element to hold various schemas for the specification.
• Optional externalDocs: OpenApiExternalDocumentation
Additional external documentation.
• info: OpenApiInfo
Provides metadata about the API. The metadata MAY be used by the clients if needed.
• Optional jsonSchemaDialect: string
The default value for the $schema keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.
• openapi: string
This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses.
• Optional paths: OpenApiPaths
The available paths and operations for the API.
• Optional security: Record<string, string[]>
A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement ({}) can be included in the array.
• Optional servers: OpenApiServer[]
An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with an url value of /.
• Optional tags: OpenApiTag[]
A list of tags used by the document with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.
• Optional webhooks: Record<string, OpenApiPathItem>
He incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the callbacks feature, this section describes requests initiated other than by an API call, for example by an out-of-band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses.