Struct ApiParameter 

pub struct ApiParameter {
    pub name: String,
    pub location: ParameterLocation,
    pub description: Option<String>,
    pub required: bool,
    pub deprecated: bool,
    pub schema: Option<SchemaDefinition>,
    pub example: Option<String>,
}

API parameter.

Fields

name: String

Parameter name.

location: ParameterLocation

Parameter location.

description: Option<String>

Parameter description.

required: bool

Whether the parameter is required.

deprecated: bool

Whether the parameter is deprecated.

schema: Option<SchemaDefinition>

Parameter schema.

example: Option<String>

Example value.

Trait Implementations

impl Clone for ApiParameter

fn clone(&self) -> ApiParameter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiParameter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ApiParameter

fn eq(&self, other: &ApiParameter) -> 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 StructuralPartialEq for ApiParameter