Struct jsona_openapi::Header
source · [−]pub struct Header {
pub description: Option<String>,
pub required: Option<bool>,
pub deprecated: Option<bool>,
pub allow_empty_value: Option<bool>,
pub style: Option<ParameterStyle>,
pub explode: Option<bool>,
pub allow_reserved: Option<bool>,
pub schema: Option<Schema>,
pub examples: Option<OneOrMultiExample>,
}
Expand description
The Header Object follows the structure of the Parameter Object with the following changes:
name
MUST NOT be specified, it is given in the correspondingheaders
map.in
MUST NOT be specified, it is implicitly inheader
.- All traits that are affected by the location MUST be applicable to a location of
header
(for example,style
).
See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#headerObject.
Fields
description: Option<String>
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
required: Option<bool>
deprecated: Option<bool>
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
allow_empty_value: Option<bool>
Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.
style: Option<ParameterStyle>
Describes how the parameter value will be serialized depending on the type of the parameter
value. Default values (based on value of in): for query
- form
; for path
- simple
; for
header
- simple
; for cookie - form
.
explode: Option<bool>
When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.
allow_reserved: Option<bool>
Determines whether the parameter value SHOULD allow reserved characters as defined by RFC3986 :/?#[]@!$&’()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false.
schema: Option<Schema>
The schema defining the type used for the parameter.
examples: Option<OneOrMultiExample>
Example of the parameter type.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Header
impl<'de> Deserialize<'de> for Header
sourcefn 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
sourceimpl PartialEq<Header> for Header
impl PartialEq<Header> for Header
impl StructuralPartialEq for Header
Auto Trait Implementations
impl RefUnwindSafe for Header
impl Send for Header
impl Sync for Header
impl Unpin for Header
impl UnwindSafe for Header
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more