Type Alias oas3::OpenApiV3Spec

pub type OpenApiV3Spec = Spec;

Version 3.1.0 of the OpenAPI specification.

Refer to the official specification for more information.

Aliased Type

struct OpenApiV3Spec {
    pub openapi: String,
    pub info: Info,
    pub servers: Vec<Server>,
    pub paths: BTreeMap<String, PathItem>,
    pub components: Option<Components>,
    pub tags: Vec<Tag>,
    pub webhooks: BTreeMap<String, PathItem>,
    pub external_docs: Option<ExternalDoc>,
}

Fields

openapi: String

This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses. The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version string.

info: Info

Provides metadata about the API. The metadata MAY be used by tooling as required.

servers: Vec<Server>

An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.

paths: BTreeMap<String, PathItem>

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.

components: Option<Components>

An element to hold various schemas for the specification.

tags: Vec<Tag>

A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools’ logic. Each tag name in the list MUST be unique.

webhooks: BTreeMap<String, PathItem>

The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the callbacks feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An example is available.

See <>.

external_docs: Option<ExternalDoc>

Additional external documentation.