Spec

apple_bloom::v2

Struct Spec

pub struct Spec {Show 15 fields
    pub swagger: String,
    pub info: Info,
    pub host: Option<String>,
    pub base_path: Option<String>,
    pub schemes: Option<Vec<Scheme>>,
    pub consumes: Option<Vec<String>>,
    pub produces: Option<Vec<String>>,
    pub tags: Option<Vec<Tag>>,
    pub paths: BTreeMap<String, PathItem>,
    pub definitions: Option<BTreeMap<String, Schema>>,
    pub parameters: Option<BTreeMap<String, Parameter>>,
    pub responses: Option<BTreeMap<String, Response>>,
    pub security_definitions: Option<BTreeMap<String, Security>>,
    pub security: Option<Vec<BTreeMap<String, Vec<String>>>>,
    pub external_docs: Option<Vec<ExternalDoc>>,
}

Expand description

top level document

Fields§

§swagger: String

The Swagger version of this document.

§info: Info§host: Option<String>

The host (name or ip) of the API. Example: ‘swagger.io’ ^[^{}/ :\\]+(?::\d+)?$

§base_path: Option<String>

The base path to the API. Example: ‘/api’.

§schemes: Option<Vec<Scheme>>§consumes: Option<Vec<String>>

A list of MIME types accepted by the API.

§produces: Option<Vec<String>>

A list of MIME types the API can produce.

§tags: Option<Vec<Tag>>§paths: BTreeMap<String, PathItem>

Relative paths to the individual endpoints. They must be relative to the ‘basePath’.

§definitions: Option<BTreeMap<String, Schema>>§parameters: Option<BTreeMap<String, Parameter>>§responses: Option<BTreeMap<String, Response>>

mappings to http response codes or “default”

§security_definitions: Option<BTreeMap<String, Security>>§security: Option<Vec<BTreeMap<String, Vec<String>>>>§external_docs: Option<Vec<ExternalDoc>>

Trait Implementations§

impl Clone for Spec

fn clone(&self) -> Spec

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for Spec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for Spec

fn default() -> Spec

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Spec

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for Spec

fn eq(&self, other: &Spec) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Spec

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for Spec

Auto Trait Implementations§

impl Freeze for Spec

impl RefUnwindSafe for Spec

impl Send for Spec

impl Sync for Spec

impl Unpin for Spec

impl UnwindSafe for Spec

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where 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>

Performs the conversion.

impl<T, U> TryInto<U> for T
where 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>

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,