Struct ParamInfo 

pub struct ParamInfo {
    pub name: String,
    pub converter: Converter,
    pub title: Option<String>,
    pub description: Option<String>,
    pub deprecated: bool,
    pub example: Option<Value>,
    pub examples: Vec<(String, Value)>,
}

Path parameter information with optional OpenAPI metadata.

Fields

name: String

Parameter name.

converter: Converter

Type converter.

title: Option<String>

Title for display in OpenAPI documentation.

description: Option<String>

Description for OpenAPI documentation.

deprecated: bool

Whether the parameter is deprecated.

example: Option<Value>

Example value for OpenAPI documentation.

examples: Vec<(String, Value)>

Named examples for OpenAPI documentation.

Implementations

impl ParamInfo

pub fn new(name: impl Into<String>, converter: Converter) -> Self

Create a new parameter info with name and converter.

pub fn with_title(self, title: impl Into<String>) -> Self

Set the title for OpenAPI documentation.

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

Set the description for OpenAPI documentation.

pub fn deprecated(self) -> Self

Mark the parameter as deprecated.

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

Set an example value for OpenAPI documentation.

pub fn with_named_example(self, name: impl Into<String>, value: Value) -> Self

Add a named example for OpenAPI documentation.

Trait Implementations

impl Clone for ParamInfo

fn clone(&self) -> ParamInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamInfo

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

Formats the value using the given formatter.

impl Default for ParamInfo

fn default() -> ParamInfo

Returns the “default value” for a type.