[I] OpenAPIDocument3_1
Extends
Indexable
[key: `x-${string}`]: anyProperties
| Property | Type | Description |
|---|---|---|
components? | OpenAPIComponents3_1 | An element to hold various schemas for the specification. |
externalDocs? | OpenAPI3ExternalDocs | Additional external documentation. |
info | OpenAPI3Info | Provides metadata about the API. The metadata can be used by the clients if needed. |
jsonSchemaDialect? | string | The default value for the $schema keyword within Schema Objects contained within this document. This MUST be in the form of a URI. |
openapi | "3.1.0" | - |
paths | Record<string, OpenAPI3PathItem> | The available paths and operations for the API |
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. |
servers? | OpenAPI3Server[] | 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 a url value of /. |
tags? | OpenAPI3Tag[] | A list of tags used by the specification 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. |
webhooks? | Record<string, OpenAPI3PathItem> | The incoming webhooks that may be received as part of this API. The key name is a unique string to refer to each webhook. |