Struct jsona_openapi::Openapi
source · [−]pub struct Openapi {
pub openapi: String,
pub info: Info,
pub servers: Option<Vec<Server>>,
pub security: Option<Vec<SecurityRequirement>>,
pub tags: Option<Vec<Tag>>,
pub external_docs: Option<ExternalDoc>,
pub paths: IndexMap<String, PathItem>,
pub components: Option<Components>,
}
Expand description
top level document
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: Option<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 /
.
security: Option<Vec<SecurityRequirement>>
Additional external documentation. 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.
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.
external_docs: Option<ExternalDoc>
paths: IndexMap<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.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Openapi
impl<'de> Deserialize<'de> for Openapi
sourcefn 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>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<Openapi> for Openapi
impl PartialEq<Openapi> for Openapi
impl StructuralPartialEq for Openapi
Auto Trait Implementations
impl RefUnwindSafe for Openapi
impl Send for Openapi
impl Sync for Openapi
impl Unpin for Openapi
impl UnwindSafe for Openapi
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more