Struct OpenApiParameter 

pub struct OpenApiParameter {
    pub name: String,
    pub location: String,
    pub required: bool,
    pub schema: Value,
    pub description: Option<String>,
    pub extra: Map<String, Value>,
}

An OpenAPI parameter.

Fields

name: String

Parameter name.

location: String

Location: “path”, “query”, “header”, or “cookie”.

required: bool

Whether the parameter is required.

schema: Value

Parameter schema.

description: Option<String>

Parameter description.

extra: Map<String, Value>

Additional fields.

Implementations

impl OpenApiParameter

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

Create a path parameter.

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

Create a query parameter.

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

Create a header parameter.

pub fn with_schema(self, schema: Value) -> Self

Set the schema.

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

Set the description.

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<'de> Deserialize<'de> for OpenApiParameter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpenApiParameter

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