Struct rweb_openapi::v3_0::Parameter

pub struct Parameter {
    pub name: Str,
    pub location: Location,
    pub required: Option<bool>,
    pub schema: Option<Schema>,
    pub unique_items: Option<bool>,
    pub param_type: Type,
    pub format: Str,
    pub description: Str,
    pub style: Option<ParameterStyle>,
}

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: Str

The name of the parameter.

location: Location

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

required: Option<bool>

schema: Option<Schema>

unique_items: Option<bool>

param_type: Type

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

format: Str

description: Str

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

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.

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

fn eq(&self, other: &Parameter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Parameter) -> bool

This method tests for !=.

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