Struct openapiv3::ParameterData [−][src]
pub struct ParameterData { pub name: String, pub description: Option<String>, pub required: bool, pub deprecated: Option<bool>, pub format: ParameterSchemaOrContent, pub example: Option<Value>, pub examples: IndexMap<String, ReferenceOr<Example>>, pub explode: Option<bool>, pub extensions: IndexMap<String, Value>, }
Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.
Fields
name: String
REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is “path”, the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information.
If in is “header” and the name field is “Accept”, “Content-Type” or “Authorization”, the parameter definition SHALL be ignored.
For all other cases, the name corresponds to the parameter name used by the in property.
description: Option<String>
A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
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>>
explode: Option<bool>
extensions: IndexMap<String, Value>
Inline extensions to this object.
Trait Implementations
impl Clone for ParameterData
[src]
impl Clone for ParameterData
[src]fn clone(&self) -> ParameterData
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'de> Deserialize<'de> for ParameterData
[src]
impl<'de> Deserialize<'de> for ParameterData
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<ParameterData> for ParameterData
[src]
impl PartialEq<ParameterData> for ParameterData
[src]fn eq(&self, other: &ParameterData) -> bool
[src]
fn ne(&self, other: &ParameterData) -> bool
[src]
impl Serialize for ParameterData
[src]
impl Serialize for ParameterData
[src]impl StructuralPartialEq for ParameterData
[src]
impl StructuralPartialEq for ParameterData
[src]Auto Trait Implementations
impl RefUnwindSafe for ParameterData
impl RefUnwindSafe for ParameterData
impl Send for ParameterData
impl Send for ParameterData
impl Sync for ParameterData
impl Sync for ParameterData
impl Unpin for ParameterData
impl Unpin for ParameterData
impl UnwindSafe for ParameterData
impl UnwindSafe for ParameterData
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]