[−][src]Struct jsona_openapi_spec::Header
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.
schema: Option<Schema>
required: Option<bool>
deprecated: Option<bool>
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
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.
Trait Implementations
impl Clone for Header
[src]
impl Debug for Header
[src]
impl Default 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 PartialEq<Header> for Header
[src]
impl Serialize for Header
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for Header
[src]
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,