Struct Parameter 

pub struct Parameter { /* private fields */ }

A single request parameter: a path segment, a query key, a header, or a cookie.

Pass it to Operation::parameter. The value is documented as a string unless schema names another type:

use topcoat::openapi::{Operation, Parameter};

let operation = Operation::new().parameter(
    Parameter::path("post_id")
        .schema::<u64>()
        .description("The post to load."),
);

Path parameters are documented even without an entry, because they are part of the route’s path. Add one to describe the parameter or to give it a type.

Implementations

impl Parameter

pub fn path(name: impl Into<Cow<'static, str>>) -> Self

Describes the path parameter name, written {name} in the route’s path. A path parameter is always required.

pub fn query(name: impl Into<Cow<'static, str>>) -> Self

Describes the query string key name.

pub fn header(name: impl Into<Cow<'static, str>>) -> Self

Describes the request header name.

pub fn cookie(name: impl Into<Cow<'static, str>>) -> Self

Describes the cookie name.

pub fn description(self, description: impl Into<Cow<'static, str>>) -> Self

Explains what the parameter is for.

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

Chooses whether a request has to send the parameter. Parameters are optional by default, except path parameters, which are always required.

pub fn schema<T: JsonSchema>(self) -> Self

Documents the parameter’s value with the schema of T, for example .schema::<u64>() for a numeric ID.

Trait Implementations

impl Clone for Parameter

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 Parameter

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

Formats the value using the given formatter.