Struct Components

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

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.

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#componentsObject.

Fields

schemas: Option<IndexMap<String, Schema>>

An object to hold reusable Schema Objects.

responses: Option<IndexMap<String, ObjectOrReference<Response>>>

An object to hold reusable Response Objects.

parameters: Option<IndexMap<String, ObjectOrReference<Parameter>>>

An object to hold reusable Parameter Objects.

examples: Option<IndexMap<String, ObjectOrReference<Example>>>

An object to hold reusable Example

request_bodies: Option<IndexMap<String, ObjectOrReference<RequestBody>>>

An object to hold reusable Request Body Objects.

headers: Option<IndexMap<String, ObjectOrReference<Header>>>

An object to hold reusable Header Objects.

security_schemes: Option<IndexMap<String, ObjectOrReference<SecurityScheme>>>

An object to hold reusable Security Scheme Objects.

links: Option<IndexMap<String, ObjectOrReference<Link>>>

An object to hold reusable Link Objects.

callbacks: Option<IndexMap<String, ObjectOrReference<Callback>>>

An object to hold reusable Callback Objects.

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

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<Self, __D::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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Components