Struct Components 

pub struct Components {
    pub schemas: Option<BTreeMap<String, Referenceable<Schema>>>,
    pub responses: Option<BTreeMap<String, Referenceable<Response>>>,
    pub parameters: Option<BTreeMap<String, Referenceable<Parameter>>>,
    pub examples: Option<BTreeMap<String, Referenceable<Example>>>,
    pub request_bodies: Option<BTreeMap<String, Referenceable<RequestBody>>>,
    pub headers: Option<BTreeMap<String, Referenceable<Header>>>,
    pub security_schemes: Option<BTreeMap<String, Referenceable<SecurityScheme>>>,
    pub links: Option<BTreeMap<String, Referenceable<Link>>>,
    pub callbacks: Option<BTreeMap<String, Referenceable<Callback>>>,
}

Holds a set of reusable objects for different aspects of the OAS.

Fields

schemas: Option<BTreeMap<String, Referenceable<Schema>>>

An object to hold reusable Schema Objects.

responses: Option<BTreeMap<String, Referenceable<Response>>>

An object to hold reusable Response Objects.

parameters: Option<BTreeMap<String, Referenceable<Parameter>>>

An object to hold reusable Parameter Objects.

examples: Option<BTreeMap<String, Referenceable<Example>>>

An object to hold reusable Example Objects.

request_bodies: Option<BTreeMap<String, Referenceable<RequestBody>>>

An object to hold reusable Request Body Objects.

headers: Option<BTreeMap<String, Referenceable<Header>>>

An object to hold reusable Header Objects.

security_schemes: Option<BTreeMap<String, Referenceable<SecurityScheme>>>

An object to hold reusable Security Scheme Objects.

links: Option<BTreeMap<String, Referenceable<Link>>>

An object to hold reusable Link Objects.

callbacks: Option<BTreeMap<String, Referenceable<Callback>>>

An object to hold reusable Callback Objects.

Implementations

impl Components

pub fn new() -> Self

pub fn with_schemas( self, schemas: BTreeMap<String, Referenceable<Schema>>, ) -> Self

pub fn with_responses( self, responses: BTreeMap<String, Referenceable<Response>>, ) -> Self

pub fn with_parameters( self, parameters: BTreeMap<String, Referenceable<Parameter>>, ) -> Self

impl Components

pub fn to_string(&self) -> String

pub fn to_value(&self) -> Value

Trait Implementations

impl Clone for Components

fn clone(&self) -> Components

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Components

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

Formats the value using the given formatter.

impl Default for Components

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Components

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Components

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.