Expand description
Structures used in parsing and navigating OpenAPI specifications.
High-level structures include Spec, Components & Schema.
Structs§
- Authorization
Code Flow - Configuration details for a authorization code OAuth Flow.
- Boolean
Schema - A boolean JSON schema.
- Callback
- Map of possible out-of band callbacks related to the parent operation.
- Client
Credentials Flow - Configuration details for a client credentials OAuth Flow.
- Components
- Holds a set of reusable objects for different aspects of the OAS.
- Contact
- Contact information for the exposed API.
- Discriminator
- A discriminator object can be used to aid in serialization, deserialization, and validation when payloads may be one of a number of different schemas.
- Encoding
- A single encoding definition applied to a single schema property.
- Example
- Multi-purpose example objects.
- External
Doc - Allows referencing an external resource for extended documentation.
- Flows
- Allows configuration of the supported OAuth Flows.
- Header
- Describes a single header for HTTP responses and for individual parts in multipart representations.
- Implicit
Flow - Configuration details for a implicit OAuth Flow.
- Info
- General information about the API.
- Invalid
Email - Error raised when contact info contains an email field which is not a valid email.
- License
- License information for the exposed API.
- Media
Type - Each Media Type Object provides schema and examples for the media type identified by its key.
- Object
Schema - A schema object allows the definition of input and output data types.
- Operation
- Describes a single API operation on a path.
- Parameter
- Describes a single operation parameter.
- Password
Flow - Configuration details for a password OAuth Flow.
- Path
Item - Describes the operations available on a single path.
- Ref
- Parsed reference path.
- Request
Body - Describes a single request body.
- Response
- Describes a single response from an API Operation, including design-time, static
linksto operations based on the response. - Security
Requirement - Lists the required security schemes to execute this operation.
- Server
- An object representing a Server.
- Server
Variable - An object representing a Server Variable for server URL template substitution.
- Spec
- A complete OpenAPI specification.
- Tag
- Adds metadata to a single tag that is used by the Operation Object.
Enums§
- Error
- Spec errors.
- Link
- The Link object represents a possible design-time link for a response.
- Media
Type Examples - Examples for a media type.
- Object
OrReference - Container for a type of OpenAPI object, or a reference to one.
- Parameter
In - Parameter location.
- Parameter
Style - Parameter style.
- RefError
- Object reference error.
- RefType
- Component type of a reference.
- Schema
- A JSON schema document.
- Schema
Error - Schema errors.
- Schema
Type - Single schema type.
- Schema
Type Set - Set of schema types.
- Security
Scheme - Defines a security scheme that can be used by the operations.
Traits§
- FromRef
- Find an object from a reference path (
$ref).