Struct Parameter

pub struct Parameter {
    pub name: String,
    pub location: ParameterLocation,
    pub required: Option<bool>,
    pub schema: Option<ReferenceOrSchema>,
    pub unique_items: Option<bool>,
    pub type_: Option<String>,
    pub format: Option<String>,
    pub description: Option<String>,
    pub items: Option<ReferenceOrSchema>,
    pub default: Option<Value>,
    pub collection_format: Option<String>,
}

Available on crate feature v2 only.

Fields

name: String

location: ParameterLocation

required: Option<bool>

schema: Option<ReferenceOrSchema>

Only relevant for ParameterLocation::Body

unique_items: Option<bool>

type_: Option<String>

format: Option<String>

description: Option<String>

items: Option<ReferenceOrSchema>

Required if type is array.

default: Option<Value>

collection_format: Option<String>

Implementations

impl Parameter

pub fn valid_v3_location(&self) -> bool

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

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 TryInto<RefOr<Parameter>> for Parameter

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<RefOr<Parameter>, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Parameter