Struct OpenApiRequestBody 

pub struct OpenApiRequestBody {
    pub description: Option<String>,
    pub required: bool,
    pub content: BTreeMap<String, OpenApiMediaType>,
}

OpenAPI request body metadata.

Fields

description: Option<String>

required: bool

content: BTreeMap<String, OpenApiMediaType>

Implementations

impl OpenApiRequestBody

pub fn content(content_type: impl Into<String>, schema: OpenApiSchema) -> Self

pub fn json(schema: OpenApiSchema) -> Self

pub fn try_content_example<T>( content_type: impl Into<String>, schema: OpenApiSchema, example: T, ) -> Result<Self>

where T: Serialize,

pub fn try_json_example<T>(schema: OpenApiSchema, example: T) -> Result<Self>

where T: Serialize,

pub fn with_description(self, description: impl Into<String>) -> Self

pub fn optional(self) -> Self

pub fn try_with_content_example<T>( self, content_type: impl Into<String>, example: T, ) -> Result<Self>

where T: Serialize,

pub fn try_with_content_named_example<T>( self, content_type: impl Into<String>, name: impl Into<String>, example: T, ) -> Result<Self>

where T: Serialize,

pub fn with_content_named_example_ref( self, content_type: impl Into<String>, name: impl Into<String>, component_name: impl AsRef<str>, ) -> Self

pub fn try_with_json_example<T>(self, example: T) -> Result<Self>

where T: Serialize,

pub fn try_with_json_named_example<T>( self, name: impl Into<String>, example: T, ) -> Result<Self>

where T: Serialize,

pub fn with_json_named_example_ref( self, name: impl Into<String>, component_name: impl AsRef<str>, ) -> Self

Trait Implementations

impl Clone for OpenApiRequestBody

fn clone(&self) -> OpenApiRequestBody

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenApiRequestBody

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

Formats the value using the given formatter.

impl PartialEq for OpenApiRequestBody

fn eq(&self, other: &OpenApiRequestBody) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for OpenApiRequestBody

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OpenApiRequestBody