Struct openapiv3::Header [−][src]
pub struct Header { pub description: Option<String>, pub style: HeaderStyle, pub required: bool, pub deprecated: Option<bool>, pub format: ParameterSchemaOrContent, pub example: Option<Value>, pub examples: IndexMap<String, ReferenceOr<Example>>, pub extensions: IndexMap<String, Value>, }
The Header Object follows the structure of the Parameter Object with the following changes:
- name MUST NOT be specified, it is given in the corresponding headers map.
- in MUST NOT be specified, it is implicitly in header.
- All traits that are affected by the location MUST be applicable to a location of header (for example, style).
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: 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: IndexMap<String, ReferenceOr<Example>>
extensions: IndexMap<String, Value>
Inline extensions to this object.
Trait Implementations
impl<'de> Deserialize<'de> for Header
[src]
impl<'de> Deserialize<'de> for Header
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl StructuralPartialEq for Header
[src]
impl StructuralPartialEq for Header
[src]Auto Trait Implementations
impl RefUnwindSafe for Header
impl RefUnwindSafe for Header
impl UnwindSafe for Header
impl UnwindSafe for Header
Blanket Implementations
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]