Struct utoipa::openapi::path::Parameter

#[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<Component>,
    pub style: Option<ParameterStyle>,
    pub explode: Option<bool>,
    pub allow_reserved: Option<bool>,
    /* private fields */
}

Implements OpenAPI Parameter Object for Operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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 or Authorization 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 be Required::True.

deprecated: Option<Deprecated>

Delcares the parameter deprecated status.

schema: Option<Component>

Schema of the parameter. Typically Component::Property 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 wheter parameter should allow reserved characters defined by RFC3986 :/?#[]@!$&'()*+,;=. This is only applicable with ParameterIn::Query. Default value is false.

Implementations

impl Parameter

pub fn new<S: Into<String>>(name: S) -> Self

Constructs a new required Parameter with given name.

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 Default for Parameter

fn default() -> Parameter

Returns the “default value” for a type.

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 From<Parameter> for ParameterBuilder

fn from(value: Parameter) -> Self

Converts to this type from the input type.

impl From<ParameterBuilder> for Parameter

fn from(value: ParameterBuilder) -> Self

Converts to this type from the input type.

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.