#[non_exhaustive]pub struct Parameter {
pub name: String,
pub parameter_in: ParameterIn,
pub description: Option<String>,
pub required: Required,
pub deprecated: Option<Deprecated>,
pub schema: Option<RefOr<Schema>>,
pub style: Option<ParameterStyle>,
pub explode: Option<bool>,
pub allow_reserved: Option<bool>,
/* private fields */
}
Expand description
Implements OpenAPI Parameter Object for Operation
.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: String
Name of the parameter.
- For
ParameterIn::Path
this must in accordance to path templating. - For
ParameterIn::Query
Content-Type
orAuthorization
value will be ignored.
parameter_in: ParameterIn
Parameter location.
description: Option<String>
Markdown supported description of the parameter.
required: Required
Declares whether the parameter is required or not for api.
- For
ParameterIn::Path
this must and will beRequired::True
.
deprecated: Option<Deprecated>
Declares the parameter deprecated status.
schema: Option<RefOr<Schema>>
Schema of the parameter. Typically Schema::Object
is used.
style: Option<ParameterStyle>
Describes how Parameter
is being serialized depending on Parameter::schema
(type of a content).
Default value is based on ParameterIn
.
explode: Option<bool>
When true
it will generate separate parameter value for each parameter with array
and object
type.
This is also true
by default for ParameterStyle::Form
.
With explode false
:
color=blue,black,brown
With explode true
:
color=blue&color=black&color=brown
allow_reserved: Option<bool>
Defines whether parameter should allow reserved characters defined by
RFC3986 :/?#[]@!$&'()*+,;=
.
This is only applicable with ParameterIn::Query
. Default value is false
.
Implementations§
Trait Implementations§
source§impl<'de> Deserialize<'de> for Parameter
impl<'de> Deserialize<'de> for Parameter
source§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>,
source§impl From<Parameter> for ParameterBuilder
impl From<Parameter> for ParameterBuilder
source§impl From<ParameterBuilder> for Parameter
impl From<ParameterBuilder> for Parameter
source§fn from(value: ParameterBuilder) -> Self
fn from(value: ParameterBuilder) -> Self
source§impl PartialEq for Parameter
impl PartialEq for Parameter
impl StructuralPartialEq for Parameter
Auto Trait Implementations§
impl Freeze for Parameter
impl RefUnwindSafe for Parameter
impl Send for Parameter
impl Sync for Parameter
impl Unpin for Parameter
impl UnwindSafe for Parameter
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)