api-morph / OpenAPIObject
Interface: OpenAPIObject
Defined in: src/types/openapi.ts:10
This is the root object of the OpenAPI Description.
See
https://spec.openapis.org/oas/v3.1.1#openapi-object
Indexable
[key: `x-${string}`]: any
This object MAY be extended with Specification Extensions.
Properties
components?
optionalcomponents:ComponentsObject
Defined in: src/types/openapi.ts:52
An element to hold various Objects for the OpenAPI Description.
externalDocs?
optionalexternalDocs:ExternalDocumentationObject
Defined in: src/types/openapi.ts:74
Additional external documentation.
info
info:
InfoObject
Defined in: src/types/openapi.ts:21
REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.
jsonSchemaDialect?
optionaljsonSchemaDialect:string
Defined in: src/types/openapi.ts:27
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
openapi:
"3.1.0"|"3.1.1"
Defined in: src/types/openapi.ts:16
REQUIRED. This string MUST be the version number of the OpenAPI Specification that the OpenAPI Document uses. The openapi field SHOULD be used by tooling to interpret the OpenAPI Document. This is not related to the API info.version string.
paths?
optionalpaths:PathsObject
Defined in: src/types/openapi.ts:38
The available paths and operations for the API.
security?
optionalsecurity:SecurityRequirementObject[]
Defined in: src/types/openapi.ts:61
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. The list can be incomplete, up to being empty or absent. To make security explicitly optional, an empty security requirement ({}) can be included in the array.
servers?
optionalservers:ServerObject[]
Defined in: src/types/openapi.ts:33
An array of Server Objects, which provide connectivity information to a target server. If the servers field is not provided, or is an empty array, the default value would be a Server Object with a url value of /.
tags?
optionaltags:TagObject[]
Defined in: src/types/openapi.ts:69
A list of tags used by the OpenAPI Description 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?
optionalwebhooks:Record<string,PathItemObject>
Defined in: src/types/openapi.ts:47
The 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.