Struct jsona_openapi_spec::Parameter

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

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.

schema: Option<Schema>

required: Option<bool>

deprecated: Option<bool>

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

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.

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