pub struct Parameter {
pub name: String,
pub location: String,
pub required: Option<bool>,
pub schema: Option<Schema>,
pub unique_items: Option<bool>,
pub param_type: Option<String>,
pub format: Option<String>,
pub description: Option<String>,
/* private fields */
}
Expand description
Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.
See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#parameterObject.
Fields§
§name: String
The name of the parameter.
location: String
values depend on parameter type
may be header
, query
, ’path,
formData`
required: Option<bool>
§schema: Option<Schema>
§unique_items: Option<bool>
§param_type: Option<String>
string, number, boolean, integer, array, file ( only for formData )
format: Option<String>
§description: Option<String>
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
Trait Implementations§
Source§impl<'de> Deserialize<'de> for Parameter
impl<'de> Deserialize<'de> for Parameter
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl StructuralPartialEq for Parameter
Auto Trait Implementations§
impl Freeze for Parameter
impl RefUnwindSafe for Parameter
impl Send for Parameter
impl Sync for Parameter
impl Unpin for Parameter
impl UnwindSafe for Parameter
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more