A map of possible out-of band callbacks related to the parent operation. Each value in the map is a Path Item 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.
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.
When using the discriminator, inline schemas will not be considered.
A single encoding definition applied to a single schema property.
Allows referencing an external resource for extended documentation.
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.
represents a possible design-time link for a response.
Each Media Type Object provides schema and examples for the media type identified by its key.
Configuration details for a supported OAuth Flow
the root document object of openAPI v3.0
Describes a single API operation on a path.
Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.
Parameter Locations
There are four possible parameter locations specified by the in field:
Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.
A simple object to allow referencing other components in the specification, internally and externally.
Describes a single request body.
Describes a single response from an API Operation, including design-time, static links to operations based on the response.
A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.
The default MAY be used as a default response object for all HTTP codes that are not covered individually by the specification.
The Responses Object MUST contain at least one response code, and it SHOULD be the response for a successful operation call.
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays.
Lists the required security schemes to execute this operation.
Defines a security scheme that can be used by the operations.
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 Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.