Struct anicca::openapi::Header [−][src]
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
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for Header
impl UnwindSafe for Header
Blanket Implementations
Mutably borrows from an owned value. Read more