Struct rweb_openapi::v3_0::Parameter [−][src]
pub struct Parameter { pub name: Str, pub location: Location, pub description: Str, pub required: Option<bool>, pub deprecated: Option<bool>, pub style: Option<ParameterStyle>, pub explode: Option<bool>, pub allow_reserved: Option<bool>, pub representation: Option<ParameterRepresentation>, pub example: Option<ParameterExamples>, }
Expand description
Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.
See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterObject.
Fields
name: Str
The name of the parameter. Parameter names are case sensitive.
location: Location
The location of the parameter. Possible values are "query"
, "header"
, "path"
or "cookie"
.
description: Str
A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
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.
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
.
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
.
representation: Option<ParameterRepresentation>
The schema defining the type used for the parameter or a map containing the representations for the parameter.
example: Option<ParameterExamples>
Example(s) of the parameter’s potential value
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 Parameter
impl UnwindSafe for Parameter
Blanket Implementations
Mutably borrows from an owned value. Read more