Struct utoipa::openapi::path::ParameterBuilder
source · pub struct ParameterBuilder { /* private fields */ }
Expand description
Implementations§
source§impl ParameterBuilder
impl ParameterBuilder
sourcepub fn new() -> ParameterBuilder
pub fn new() -> ParameterBuilder
Constructs a new ParameterBuilder
.
source§impl ParameterBuilder
impl ParameterBuilder
sourcepub fn parameter_in(self, parameter_in: ParameterIn) -> Self
pub fn parameter_in(self, parameter_in: ParameterIn) -> Self
Add in of the Parameter
.
sourcepub fn required(self, required: Required) -> Self
pub fn required(self, required: Required) -> Self
Add required declaration of the Parameter
. If ParameterIn::Path
is
defined this is always Required::True
.
sourcepub fn description<S: Into<String>>(self, description: Option<S>) -> Self
pub fn description<S: Into<String>>(self, description: Option<S>) -> Self
Add or change description of the Parameter
.
sourcepub fn deprecated(self, deprecated: Option<Deprecated>) -> Self
pub fn deprecated(self, deprecated: Option<Deprecated>) -> Self
Add or change Parameter
deprecated declaration.
sourcepub fn schema<I: Into<RefOr<Schema>>>(self, component: Option<I>) -> Self
pub fn schema<I: Into<RefOr<Schema>>>(self, component: Option<I>) -> Self
Add or change Parameter
s schema.
sourcepub fn style(self, style: Option<ParameterStyle>) -> Self
pub fn style(self, style: Option<ParameterStyle>) -> Self
Add or change serialization style of Parameter
.
sourcepub fn explode(self, explode: Option<bool>) -> Self
pub fn explode(self, explode: Option<bool>) -> Self
Define whether Parameter
s are exploded or not.
sourcepub fn allow_reserved(self, allow_reserved: Option<bool>) -> Self
pub fn allow_reserved(self, allow_reserved: Option<bool>) -> Self
Add or change whether Parameter
should allow reserved characters.
Trait Implementations§
source§impl Default for ParameterBuilder
impl Default for ParameterBuilder
source§impl From<Parameter> for ParameterBuilder
impl From<Parameter> for ParameterBuilder
source§impl From<ParameterBuilder> for Parameter
impl From<ParameterBuilder> for Parameter
source§fn from(value: ParameterBuilder) -> Self
fn from(value: ParameterBuilder) -> Self
Converts to this type from the input type.