A map of possible out-of band callbacks related to the parent operation. Each value in the map is a OasPathItem object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the path item object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.
Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.
Contact information for the exposed API.
When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.
The root document of an OpenAPI Specification.
A single encoding definition applied to a single schema property.
Allows referencing an external resource for extended documentation.
Data about OasHeader. The OasHeader object follows the structure of the OasParameter object with the following changes:
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.
License information for the exposed API.
The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.
Each OasMediaType object provides schema and examples for the media type identified by its key.
Configuration details for a supported OAuth Flow.
Allows configuration of the supported OAuth Flows.
Describes a singel API operation on a path.
Describes a single operation parameter.
Describes the operations available on a single path. A Path Item MAY be empty, due to [ACL constraints](https://swagger.io/specification/#security-filtering). The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.
Describes a single response from an API Operation, including design-time, static links to operations based on the response.
The OasSchema object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is an extended subset of the [JSON Schema Specification Wright Draft 00](https://json-schema.org/).
Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and [OpenID Connect Discovery](https://tools.ietf.org/html/draft-ietf-oauth-discovery-06).
An object representing a Server.
An object representing a Server Variable for server URL template substitution.
Adds metadata to a single tag that is used by the OasOperation object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.
Data structures needed to parse and document an OpenAPI Specification.