Struct ParamSpec 

#[non_exhaustive]
pub struct ParamSpec {
    pub name: String,
    pub location: ParamLocation,
    pub required: bool,
    pub description: Option<String>,
    pub param_type: String,
    pub array: bool,
    pub format: Option<String>,
    pub minimum: Option<f64>,
}

Parameter specification built with location constructors and fluent setters. #[non_exhaustive] allows new schema keywords without changing call sites.

let version = ParamSpec::query("expected_resource_version")
    .required(true)
    .param_type("integer")
    .format("int64")
    .minimum(1.0);
assert_eq!(version.location, ParamLocation::Query);
assert_eq!(version.format.as_deref(), Some("int64"));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

location: ParamLocation

required: bool

description: Option<String>

param_type: String

array: bool

Whether the parameter repeats. When set, param_type describes the item type and the parameter renders as type: array with style: form, explode: true — i.e. ?tag=a&tag=b, which is how the generated REST client encodes a Vec<T> query field.

format: Option<String>

Optional JSON Schema format token, kept independent of utoipa types.

minimum: Option<f64>

Optional JSON Schema minimum.

Implementations

impl ParamSpec

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

A required path parameter — string unless Self::param_type says otherwise.

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

An optional query parameter.

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

An optional header parameter.

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

An optional cookie parameter.

pub fn required(self, required: bool) -> Self

Whether the caller must send this parameter; path parameters are always required.

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

The description a generated client’s documentation carries.

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

JSON Schema type, or item type for arrays.

pub fn array(self, array: bool) -> Self

Whether the parameter repeats — see Self::array.

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

The JSON Schema format token, e.g. int64.

pub fn minimum(self, minimum: f64) -> Self

The JSON Schema minimum.

Trait Implementations

impl Clone for ParamSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamSpec

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

Formats the value using the given formatter.