Struct anicca::openapi::Header

pub struct Header {
    pub description: Option<String>,
    pub style: HeaderStyle,
    pub required: Option<bool>,
    pub deprecated: Option<bool>,
    pub format: ParameterSchemaOrContent,
    pub example: Option<Value>,
    pub examples: BTreeMap<String, ReferenceOr<Example>>,
    pub extensions: BTreeMap<String, Value>,
}

Fields

description: Option<String>

A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

style: HeaderStyle

required: Option<bool>

Determines whether this parameter is mandatory. If the parameter location is “path”, this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.

deprecated: Option<bool>

Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.

format: ParameterSchemaOrContent

example: Option<Value>

examples: BTreeMap<String, ReferenceOr<Example>>

extensions: BTreeMap<String, Value>

Inline extensions to this object.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Header

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Header> for Header

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Header

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 Header