Struct dropshot::ApiEndpointParameter

pub struct ApiEndpointParameter {
    pub name: ApiEndpointParameterName,
    pub description: Option<String>,
    pub required: bool,
    pub schema: ApiSchemaGenerator,
    pub examples: Vec<String>,
}

ApiEndpointParameter represents the discrete path and query parameters for a given API endpoint. These are typically derived from the members of stucts used as parameters to handler functions.

Fields

name: ApiEndpointParameterName

description: Option<String>

required: bool

schema: ApiSchemaGenerator

examples: Vec<String>

Implementations

impl ApiEndpointParameter

pub fn new_named(
    loc: &ApiEndpointParameterLocation,
    name: String,
    description: Option<String>,
    required: bool,
    schema: ApiSchemaGenerator,
    examples: Vec<String>
) -> Self

pub fn new_body(
    description: Option<String>,
    required: bool,
    schema: ApiSchemaGenerator,
    examples: Vec<String>
) -> Self

Trait Implementations

impl Debug for ApiEndpointParameter

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

Formats the value using the given formatter.