Struct OpenApiParameter 

pub struct OpenApiParameter {
    pub name: String,
    pub location: OpenApiParameterLocation,
    pub required: bool,
    pub schema: OpenApiSchema,
    pub description: Option<String>,
    pub deprecated: bool,
    pub allow_reserved: bool,
    pub style: Option<String>,
    pub explode: Option<bool>,
    pub example: Option<Value>,
    pub examples: BTreeMap<String, OpenApiReferenceOr<OpenApiExample>>,
}

OpenAPI parameter metadata.

Fields

name: String

location: OpenApiParameterLocation

required: bool

schema: OpenApiSchema

description: Option<String>

deprecated: bool

allow_reserved: bool

style: Option<String>

explode: Option<bool>

example: Option<Value>

examples: BTreeMap<String, OpenApiReferenceOr<OpenApiExample>>

Implementations

impl OpenApiParameter

pub fn new( location: OpenApiParameterLocation, name: impl Into<String>, required: bool, schema: OpenApiSchema, ) -> Self

pub fn path(name: impl Into<String>, schema: OpenApiSchema) -> Self

pub fn query( name: impl Into<String>, required: bool, schema: OpenApiSchema, ) -> Self

pub fn header( name: impl Into<String>, required: bool, schema: OpenApiSchema, ) -> Self

pub fn cookie( name: impl Into<String>, required: bool, schema: OpenApiSchema, ) -> Self

pub fn with_description(self, description: impl Into<String>) -> Self

pub fn with_deprecated(self) -> Self

pub fn with_allow_reserved(self) -> Self

pub fn with_style(self, style: impl Into<String>) -> Self

pub fn with_explode(self, explode: bool) -> Self

pub fn with_example_value(self, example: Value) -> Self

pub fn try_with_example<T>(self, example: T) -> Result<Self>

where T: Serialize,

pub fn with_named_example_value( self, name: impl Into<String>, example: OpenApiExample, ) -> Self

pub fn try_with_named_example<T>( self, name: impl Into<String>, example: T, ) -> Result<Self>

where T: Serialize,

pub fn with_named_example_ref( self, name: impl Into<String>, component_name: impl AsRef<str>, ) -> Self

Trait Implementations

impl Clone for OpenApiParameter

fn clone(&self) -> OpenApiParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiParameter

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

Formats the value using the given formatter.

impl PartialEq for OpenApiParameter

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OpenApiParameter

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 OpenApiParameter