Struct Parameter

pub struct Parameter {
    pub name: String,
    pub location: String,
    pub required: Option<bool>,
    pub schema: Option<Schema>,
    pub unique_items: Option<bool>,
    pub param_type: Option<String>,
    pub format: Option<String>,
    pub description: Option<String>,
    /* private fields */
}

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`

required: Option<bool>

schema: Option<Schema>

unique_items: Option<bool>

param_type: Option<String>

string, number, boolean, integer, array, file ( only for formData )

format: Option<String>

description: Option<String>

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

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