OpenApiDoc

Builder for the OpenAPI root document object.

An element to hold various schemas for the specification.

Any additional external documentation for this OpenAPI document.

Additional external documentation.

Provides metadata about the API. The clients can use the metadata if needed.

The available paths and operations for the API.

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 needs 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.

An array of Server Objects, which provide connectivity information to a target server.

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.

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.