The Schema 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.
In order to support common ways of serializing simple parameters, a set of style values are defined.
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.
A single encoding definition applied to a single schema property.
Allows referencing an external resource for extended documentation.
The Header Object follows the structure of the Parameter Object
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 Media Type 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 single API operation on a path.
Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.
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.
Describes a single request body.
Describes a single response from an API Operation, including design-time, static links to operations based on the response.
Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.
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.
A metadata object that allows for more fine-tuned XML model definitions.