Struct Parameter

pub struct Parameter {
    pub name: String,
    pub location: String,
    pub description: Option<String>,
    pub required: Option<bool>,
    pub deprecated: Option<bool>,
    pub allow_empty_value: Option<bool>,
    pub style: Option<ParameterStyle>,
    pub explode: Option<bool>,
    pub allow_reserved: Option<bool>,
    pub schema: Option<Schema>,
    pub examples: Option<OneOrMultiExample>,
}

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

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterObject.

Fields

name: String

The name of the parameter.

location: String

values depend on parameter type may be header, query, ’path, formData`

description: Option<String>

A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.

required: Option<bool>

deprecated: Option<bool>

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

allow_empty_value: Option<bool>

Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.

style: Option<ParameterStyle>

Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

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. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.

allow_reserved: Option<bool>

Determines whether the parameter value SHOULD allow reserved characters as defined by RFC3986 :/?#[]@!$&’()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false.

schema: Option<Schema>

The schema defining the type used for the parameter.

examples: Option<OneOrMultiExample>

Example of the parameter type.

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

fn eq(&self, other: &Parameter) -> 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 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