[−][src]Struct oas3::Spec
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: 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.
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.
Methods
impl Spec
[src]
pub fn validate_version(&self) -> Result<Version>
[src]
pub fn get_operation(&self, method: &Method, path: &str) -> Option<&Operation>
[src]
Trait Implementations
impl Clone for Spec
[src]
fn clone(&self) -> Spec
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Default for Spec
[src]
impl PartialEq<Spec> for Spec
[src]
impl Debug for Spec
[src]
impl Serialize for Spec
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<'de> Deserialize<'de> for Spec
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
Auto Trait Implementations
impl Sync for Spec
impl Send for Spec
impl Unpin for Spec
impl RefUnwindSafe for Spec
impl UnwindSafe for Spec
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,