pub struct Parameter {Show 15 fields
pub reference: Option<String>,
pub summary: Option<String>,
pub description: Option<String>,
pub name: Option<String>,
pub location: Option<String>,
pub required: Option<bool>,
pub deprecated: Option<bool>,
pub allow_empty_value: Option<bool>,
pub style: Option<String>,
pub explode: Option<bool>,
pub allow_reserved: Option<bool>,
pub schema: Option<Schema>,
pub example: Option<Value>,
pub examples: Option<BTreeMap<String, Example>>,
pub content: Option<BTreeMap<String, MediaType>>,
}Expand description
Operation parameter.
Describes a single operation parameter that can be located in the path, query, header, or cookie.
Fields§
§reference: Option<String>Reference to a parameter definition.
summary: Option<String>Short summary of the parameter.
description: Option<String>Description of the parameter. CommonMark syntax may be used.
name: Option<String>Name of the parameter. Required unless this is a reference.
location: Option<String>Location of the parameter: “query”, “header”, “path”, or “cookie”.
required: Option<bool>Whether the parameter is mandatory. Path parameters must be required.
deprecated: Option<bool>Whether the parameter is deprecated (default: false).
allow_empty_value: Option<bool>Whether empty-valued parameters are allowed (default: false).
style: Option<String>Serialization style for the parameter value.
explode: Option<bool>Whether to generate separate parameters for array/object values.
allow_reserved: Option<bool>Whether to allow reserved characters without percent-encoding.
schema: Option<Schema>Schema defining the parameter type.
example: Option<Value>Example value for the parameter.
examples: Option<BTreeMap<String, Example>>Multiple examples for the parameter.
content: Option<BTreeMap<String, MediaType>>Content representation for complex parameters.