Struct paperclip::v2::models::Api

pub struct Api<S> {
    pub swagger: Version,
    pub definitions: BTreeMap<String, SchemaRepr<S>>,
    pub paths: BTreeMap<String, OperationMap<S>>,
}

OpenAPI v2 spec.

Fields

swagger: Version

definitions: BTreeMap<String, SchemaRepr<S>>

paths: BTreeMap<String, OperationMap<S>>

Methods

impl<S: Schema> Api<S>

pub fn resolve(self) -> Result<Api<S>, Error>

Consumes this API schema, resolves the references and returns the resolved schema.

This walks recursively, collects the referenced schema objects, substitutes the referenced IDs with the pointer to schema objects and returns the resolved object or an error if it encountered one.

Trait Implementations

impl<S: Clone> Clone for Api<S>

fn clone(&self) -> Api<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Api<S>

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for Api<S> where
    S: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.