Struct OpenApiResponse 

pub struct OpenApiResponse {
    pub description: String,
    pub headers: BTreeMap<String, OpenApiReferenceOr<OpenApiHeader>>,
    pub content: BTreeMap<String, OpenApiMediaType>,
}

OpenAPI response metadata.

Fields

description: String

headers: BTreeMap<String, OpenApiReferenceOr<OpenApiHeader>>

content: BTreeMap<String, OpenApiMediaType>

Implementations

impl OpenApiResponse

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

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

pub fn json(description: impl Into<String>, schema: OpenApiSchema) -> Self

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

where T: Serialize,

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

where T: Serialize,

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

pub fn with_header(self, name: impl Into<String>, header: OpenApiHeader) -> Self

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

Trait Implementations

impl Clone for OpenApiResponse

fn clone(&self) -> OpenApiResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiResponse

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

Formats the value using the given formatter.

impl PartialEq for OpenApiResponse

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OpenApiResponse

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 OpenApiResponse