Struct postman2openapi::openapi::v3_0::Spec
source · pub struct Spec {
pub openapi: String,
pub info: Info,
pub servers: Option<Vec<Server>>,
pub paths: IndexMap<String, PathItem>,
pub components: Option<Components>,
pub security: Option<Vec<SecurityRequirement>>,
pub tags: Option<IndexSet<Tag>>,
pub external_docs: Option<ExternalDoc>,
}
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 /
.
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.
security: Option<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.
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>
Additional external documentation.
Implementations§
Trait Implementations§
source§impl<'de> Deserialize<'de> for Spec
impl<'de> Deserialize<'de> for Spec
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 PartialEq for Spec
impl PartialEq for Spec
impl Eq for Spec
impl StructuralPartialEq for Spec
Auto Trait Implementations§
impl RefUnwindSafe for Spec
impl Send for Spec
impl Sync for Spec
impl Unpin for Spec
impl UnwindSafe for Spec
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.