Struct ParameterData

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, RefOr<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, RefOr<Example>>

explode: Option<bool>

extensions: IndexMap<String, Value>

Inline extensions to this object.

Implementations

impl ParameterData

pub fn schema(&self) -> Option<&RefOr<Schema>>

Returns the parameter schema if it exists.

Trait Implementations

impl Clone for ParameterData

fn clone(&self) -> ParameterData

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParameterData

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParameterData

fn deserialize<__D>( __deserializer: __D, ) -> Result<ParameterData, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ParameterData

fn eq(&self, other: &ParameterData) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ParameterData

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ParameterData