Structs
Contact information for the exposed API.
Allows referencing an external resource for extended documentation.
License information for the exposed API.
Describes a single 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.
The path itself is still exposed to the documentation
viewer but they will not know which operations and
parameters are available.
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.
Enums
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.
Functions
Type Definitions
Holds the relative paths to the individual endpoints and
their operations. The path is appended to the URL from the
Server Object in order to construct the full URL. The Paths
MAY be empty, due to ACL constraints.
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.