Struct Components

pub struct Components {
    pub security_schemes: RefOrMap<SecurityScheme>,
    pub responses: RefOrMap<Response>,
    pub parameters: RefOrMap<Parameter>,
    pub examples: RefOrMap<Example>,
    pub request_bodies: RefOrMap<RequestBody>,
    pub headers: RefOrMap<Header>,
    pub schemas: RefOrMap<Schema>,
    pub links: RefOrMap<Link>,
    pub callbacks: RefOrMap<IndexMap<String, PathItem>>,
    pub extensions: IndexMap<String, Value>,
}

Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.

Fields

security_schemes: RefOrMap<SecurityScheme>

An object to hold reusable Security Scheme Objects.

responses: RefOrMap<Response>

An object to hold reusable Response Objects.

parameters: RefOrMap<Parameter>

An object to hold reusable Parameter Objects.

examples: RefOrMap<Example>

An object to hold reusable Example Objects.

request_bodies: RefOrMap<RequestBody>

An object to hold reusable Request Body Objects.

headers: RefOrMap<Header>

An object to hold reusable Header Objects.

schemas: RefOrMap<Schema>

An object to hold reusable Schema Objects.

links: RefOrMap<Link>

An object to hold reusable Link Objects.

callbacks: RefOrMap<IndexMap<String, PathItem>>

An object to hold reusable Callback Objects.

extensions: IndexMap<String, Value>

Inline extensions to this object.

Implementations

impl Components

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for Components

fn clone(&self) -> Components

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Default for Components

fn default() -> Components

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Components

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

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

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 Components

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Components