Struct Parameter

pub struct Parameter {

    pub name: Option<String>,
    pub location: Option<ParameterLocation>,
    pub description: Option<String>,
    pub required: Option<bool>,
    pub schema: Option<RefOr<Schema>>,
    pub allow_empty_value: Option<bool>,
    pub x_fields: HashMap<String, Value>,
    pub schema_type: Option<ParameterSchemaType>,
    pub format: Option<String>,
    pub items: Option<Items>,
    pub collection_format: Option<String>,
    pub default: Option<Value>,
    pub maximum: Option<f64>,
    pub exclusive_maximum: Option<bool>,
    pub minimum: Option<f64>,
    pub exclusive_minimum: Option<bool>,
    pub max_length: Option<i64>,
    pub min_length: Option<i64>,
    pub pattern: Option<String>,
    pub max_items: Option<i64>,
    pub min_items: Option<i64>,
    pub unique_items: Option<bool>,
    pub enum_values: Vec<Value>,
    pub multiple_of: Option<i64>,
    pub deprecated: Option<bool>,
    pub style: Option<ParameterStyle>,
    pub explode: Option<bool>,
    pub allow_reserved: Option<bool>,
    pub example: Option<Value>,
    pub examples: HashMap<String, RefOr<Example>>,
    pub content: HashMap<String, MediaType>,
}

Parameter Object

Describes a single operation parameter. Also implicitly used for Header, with name as the key of the containing hashmap and location being implied as Header

Fields

name: Option<String>

location: Option<ParameterLocation>

description: Option<String>

required: Option<bool>

schema: Option<RefOr<Schema>>

allow_empty_value: Option<bool>

x_fields: HashMap<String, Value>

Allows extensions to the Swagger Schema. The field name MUST begin with x-, for example, x-internal-id. The value can be null, a primitive, an array or an object. See Vendor Extensions for further details.

schema_type: Option<ParameterSchemaType>

format: Option<String>

items: Option<Items>

collection_format: Option<String>

default: Option<Value>

maximum: Option<f64>

exclusive_maximum: Option<bool>

minimum: Option<f64>

exclusive_minimum: Option<bool>

max_length: Option<i64>

min_length: Option<i64>

pattern: Option<String>

max_items: Option<i64>

min_items: Option<i64>

unique_items: Option<bool>

enum_values: Vec<Value>

multiple_of: Option<i64>

deprecated: Option<bool>

style: Option<ParameterStyle>

explode: Option<bool>

allow_reserved: Option<bool>

example: Option<Value>

examples: HashMap<String, RefOr<Example>>

content: HashMap<String, MediaType>

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

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

where Parameter: Default,

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

fn resolve(spec: &Spec, path: &String) -> Result<Self, ResolveError>

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