Struct openapi_schema::v3::Parameter

pub struct Parameter {

    pub name: String,
    pub in: String,
    pub description: Option<String>,
    pub required: Option<bool>,
    pub deprecated: Option<bool>,
    pub allow_empty_value: Option<bool>,
    pub style: Option<String>,
    pub explode: Option<bool>,
    pub allow_reserved: Option<bool>,
    pub schema: Option<RefOrObject<Schema>>,
    pub example: Option<Value>,
    pub examples: Option<BTreeMap<String, RefOrObject<Example>>>,
    pub content: Option<BTreeMap<String, Media>>,
    pub extensions: Extensions,
}

Parameter

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.

Fields

name: String

The name of the parameter.

in: String

The location of the parameter. Possible values are “query”, “header”, “path” or “cookie”.

description: Option<String>

A brief description of the parameter.

required: Option<bool>

Determines whether this parameter is mandatory.

deprecated: Option<bool>

Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.

allow_empty_value: Option<bool>

Sets the ability to pass empty-valued parameters.

style: Option<String>

Describes how the parameter value will be serialized depending on the type of the parameter value.

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.

allow_reserved: Option<bool>

Determines whether the parameter value SHOULD allow reserved characters

schema: Option<RefOrObject<Schema>>

The schema defining the type used for the parameter.

example: Option<Value>

Example of the parameter’s potential value.

examples: Option<BTreeMap<String, RefOrObject<Example>>>

Examples of the parameter’s potential value.

content: Option<BTreeMap<String, Media>>

A map containing the representations for the parameter.

extensions: Extensions

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Parameter

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Parameter> for Parameter

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Parameter

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Parameter