[−][src]Struct opg::models::Operation

pub struct Operation {
    pub tags: Vec<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub security: Vec<BTreeMap<String, Vec<String>>>,
    pub request_body: Option<RequestBody>,
    pub responses: BTreeMap<u16, Response>,
    pub parameters: BTreeMap<String, OperationParameter>,
}

Operation Object

specification

Fields

tags: Vec<String>

A list of tags for API documentation control

Tags can be used for logical grouping of operations by resources or any other qualifier.

summary: Option<String>

A short summary of what the operation does

description: Option<String>

A verbose explanation of the operation behavior

security: Vec<BTreeMap<String, Vec<String>>>

A declaration of which security mechanisms can be used for this operation

request_body: Option<RequestBody>

The request body applicable for this operation

responses: BTreeMap<u16, Response>

The list of possible responses as they are returned from executing this operation

parameters: BTreeMap<String, OperationParameter>

A list of parameters that are applicable for this operation

Trait Implementations

impl Clone for Operation[src]

impl Debug for Operation[src]

impl Default for Operation[src]

impl Serialize for Operation[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.