Struct Components 

pub struct Components {
    pub schemas: Map<Schema>,
    pub responses: Map<RefOr<Response>>,
    pub parameters: Map<RefOr<Parameter>>,
    pub examples: Map<RefOr<Example>>,
    pub request_bodies: Map<RefOr<RequestBody>>,
    pub headers: Map<RefOr<Header>>,
    pub security_schemes: Map<RefOr<SecurityScheme>>,
    pub links: Map<RefOr<Link>>,
    pub callbacks: Map<RefOr<Callback>>,
    pub path_items: Map<PathItem>,
    pub media_types: Map<RefOr<MediaType>>,
    pub extensions: Extensions,
}

Reusable objects referenced from elsewhere in the description.

Nothing here has any effect until something refers to it.

Fields

schemas: Map<Schema>

Reusable schemas.

responses: Map<RefOr<Response>>

Reusable responses.

parameters: Map<RefOr<Parameter>>

Reusable parameters.

examples: Map<RefOr<Example>>

Reusable examples.

request_bodies: Map<RefOr<RequestBody>>

Reusable request bodies.

headers: Map<RefOr<Header>>

Reusable headers.

security_schemes: Map<RefOr<SecurityScheme>>

Security schemes the API can use.

links: Map<RefOr<Link>>

Reusable links.

callbacks: Map<RefOr<Callback>>

Reusable callbacks.

path_items: Map<PathItem>

Reusable path items.

media_types: Map<RefOr<MediaType>>

Reusable media type definitions.

Introduced in OpenAPI 3.2.

extensions: Extensions

Specification extensions.

Implementations

impl Components

pub fn new() -> Self

Creates an empty set of components.

pub fn insert_schema(&mut self, name: &ComponentName, schema: Schema) -> Schema

Registers a schema and returns a $ref to it.

pub fn insert_security_scheme( &mut self, name: &ComponentName, scheme: SecurityScheme, )

Registers a security scheme.

pub fn is_empty(&self) -> bool

Returns true when nothing is registered.

Trait Implementations

impl Clone for Components

fn clone(&self) -> Self

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 PartialEq for Components

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

Equality operator ==.

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

Inequality operator !=.

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