Struct Parameter 

pub struct Parameter {
    pub name: String,
    pub in: ParameterLocation,
    pub description: Option<String>,
    pub required: Option<bool>,
    pub schema: Option<SchemaRef>,
    pub example: Option<Value>,
}

Available on crate feature vespera and (crate features utoipa or vespera) only.

Parameter definition

Fields

name: String

Parameter name

in: ParameterLocation

Parameter location

description: Option<String>

Parameter description

required: Option<bool>

Whether the parameter is required

schema: Option<SchemaRef>

Schema reference or inline schema

example: Option<Value>

Example value

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Parameter

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.