Struct OpenApiOperation 

pub struct OpenApiOperation {
    pub summary: Option<String>,
    pub description: Option<String>,
    pub operation_id: Option<String>,
    pub tags: Vec<String>,
    pub deprecated: bool,
    pub parameters: Vec<OpenApiParameter>,
    pub request_body: Option<Value>,
    pub responses: Map<String, Value>,
    pub extra: Map<String, Value>,
}

An OpenAPI operation (endpoint).

Fields

summary: Option<String>

Short summary of the operation.

description: Option<String>

Extended description of the operation.

operation_id: Option<String>

Unique operation identifier.

tags: Vec<String>

Tags for grouping operations in documentation.

deprecated: bool

Whether this operation is deprecated.

parameters: Vec<OpenApiParameter>

Operation parameters.

request_body: Option<Value>

Request body definition.

responses: Map<String, Value>

Response definitions keyed by status code.

extra: Map<String, Value>

Additional fields not explicitly modeled.

Implementations

impl OpenApiOperation

pub fn new(summary: impl Into<String>) -> OpenApiOperation

Create a new operation with a summary.

pub fn with_id(self, id: impl Into<String>) -> OpenApiOperation

Set the operation ID.

pub fn with_description(self, desc: impl Into<String>) -> OpenApiOperation

Set the description.

pub fn with_tag(self, tag: impl Into<String>) -> OpenApiOperation

Add a tag.

pub fn with_tags( self, tags: impl IntoIterator<Item = impl Into<String>>, ) -> OpenApiOperation

Set multiple tags.

pub fn deprecated(self) -> OpenApiOperation

Mark as deprecated.

pub fn with_parameter(self, param: OpenApiParameter) -> OpenApiOperation

Add a parameter.

pub fn with_response( self, status: impl Into<String>, response: Value, ) -> OpenApiOperation

Add a response.

Trait Implementations

impl Clone for OpenApiOperation

fn clone(&self) -> OpenApiOperation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiOperation

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

Formats the value using the given formatter.

impl Default for OpenApiOperation

fn default() -> OpenApiOperation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenApiOperation

fn deserialize<__D>( __deserializer: __D, ) -> Result<OpenApiOperation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpenApiOperation

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OpenApiOperation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OpenApiOperation