pub struct OpenApi {
pub openapi: Cow<'static, str>,
pub info: Info,
pub json_schema_dialect: Option<String>,
pub servers: Vec<Server>,
pub paths: Option<Paths>,
pub webhooks: IndexMap<String, ReferenceOr<PathItem>>,
pub components: Option<Components>,
pub security: Vec<SecurityRequirement>,
pub tags: Vec<Tag>,
pub external_docs: Option<ExternalDocumentation>,
pub extensions: IndexMap<String, Value>,
}
Fields§
§openapi: Cow<'static, str>
§info: Info
REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.
json_schema_dialect: Option<String>
The default value for the $schema
keyword within Schema Objects
contained within this OAS document. This MUST be in the form of a URI.
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: Option<Paths>
The available paths and operations for the API.
webhooks: IndexMap<String, ReferenceOr<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.
components: Option<Components>
An element to hold various schemas for the document.
security: Vec<SecurityRequirement>
A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. Global security settings may be overridden on a per-path basis.
A list of tags used by the document 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 tool’s logic. Each tag name in the list MUST be unique.
external_docs: Option<ExternalDocumentation>
Additional external documentation.
extensions: IndexMap<String, Value>
Inline extensions to this object.
Implementations§
Trait Implementations§
source§impl<'de> Deserialize<'de> for OpenApi
impl<'de> Deserialize<'de> for OpenApi
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
source§impl JsonSchema for OpenApi
impl JsonSchema for OpenApi
source§fn schema_name() -> String
fn schema_name() -> String
source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
source§fn json_schema(gen: &mut SchemaGenerator) -> Schema
fn json_schema(gen: &mut SchemaGenerator) -> Schema
source§fn is_referenceable() -> bool
fn is_referenceable() -> bool
$ref
keyword. Read more