Module rweb_openapi::v3_0 [−][src]
Expand description
Support for OpenApi version 3.0.1 specification.
See the specification for more information.
Structs
Configuration details for a authorization code OAuth Flow See [link] [link](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#oauth-flow-object
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 callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
Configuration details for a client credentials OAuth Flow See [link] [link](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#oauth-flow-object
Holds a set of reusable objects for different aspects of the OAS.
Contact information for the exposed API.
A single encoding definition applied to a single schema property.
Allows referencing an external resource for extended documentation.
Allows configuration of the supported OAuth Flows. See [link] [link][https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#oauth-flows-object]
The Header Object follows the structure of the Parameter Object with the following changes:
Configuration details for a implicit OAuth Flow See [link] link
General information about the API.
License information for the exposed API.
The Link object 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.
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.
Configuration details for a password OAuth Flow See [link] [link](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#oauth-flow-object
Describes the operations available on a single path.
Describes a single request body.
Describes a single response from an API Operation, including design-time, static links
to operations based on the response.
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. For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema.
An object representing a Server.
An object representing a Server Variable for server URL template substitution.
top level document
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
Either a reference to a component schema or an [inline] schema itself.
Embedded literal example or a URL that points to the literal example.
The name of an existing resolvable OAS operation, or a relative or absolute reference to an OAS operation.
Example(s) of the parameter’s potential value
The schema defining the type used for the parameter or a map containing the representations for the parameter.
Runtime expression or literal value. Used for Link parameters and request_body.
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.