Struct oapi::OApiOperation

pub struct OApiOperation { /* fields omitted */ }

The OpenApi operation object

Implementations

impl OApiOperation

pub fn tags(&self) -> &Vec<String>

The tags this operation corresponds to

pub fn summary(&self) -> &Option<String>

A summary of the operation

pub fn description(&self) -> &Option<String>

A description of the operation

pub fn external_docs(&self) -> &Option<OApiExternalDocumentation>

An external documentation for this operation

pub fn operation_id(&self) -> &Option<String>

An unique operation id

pub fn parameters(&self) -> &Vec<SparseSelector<OApiParameter>>

Parameters for the operations

pub fn request_body(&self) -> &Option<SparseSelector<OApiRequestBody>>

A request body object

pub fn responses(&self) -> &HashMap<String, SparseSelector<OApiResponse>>

A map of responses

pub fn callbacks(&self) -> &HashMap<String, SparseSelector<OApiCallback>>

A map of callbacks

pub fn deprecated(&self) -> &bool

Flag marking an operation as deprecated

pub fn security(&self) -> &Vec<HashMap<String, Vec<String>>>

A list of security to use

pub fn servers(&self) -> &Vec<OApiServer>

A list of servers to use

Trait Implementations

impl Clone for OApiOperation

fn clone(&self) -> OApiOperation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OApiOperation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OApiOperation

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

Deserialize this value from the given Serde deserializer.

impl OApiCheckTrait for OApiOperation

fn oapi_check(
    &self,
    root: &SparseRoot<OApiDocument>,
    bread_crumb: &mut Vec<String>
) -> Result<(), OApiError>

Check the current object, if any checks are to be performed, then checks its inner attributes

fn oapi_check_inner(
    &self,
    root: &SparseRoot<OApiDocument>,
    bread_crumb: &mut Vec<String>
) -> Result<(), OApiError>

Check every inner attributes of the object

impl OApiExtensionExtractor for OApiOperation

fn oapi_raw_ext(&self) -> &HashMap<String, Value>

Return a map of value of the additionnal keys for that object

fn oapi_extract_ext<S>(
    &self,
    root: &SparseRoot<OApiDocument>,
    key: &str
) -> Result<S, OApiError> where
    S: DeserializeOwned + SparsableTrait + Serialize + OApiCheckTrait, 

Try to deserialize to the type S the object at key, providing the root of the document for any SparsePointer dereferencing

impl PartialEq<OApiOperation> for OApiOperation

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for OApiOperation

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

Serialize this value into the given Serde serializer.

impl Sparsable for OApiOperation

fn sparse_init(
    &mut self,
    state: &mut SparseState,
    metadata: &SparseMetadata,
    depth: u32
) -> Result<(), SparseError>

Initialize recusively a Sparsable pointer

pub fn sparse_updt(
    &mut self,
    state: &mut SparseState,
    metadata: &SparseMetadata,
    depth: u32
) -> Result<(), SparseError>

Update recusively a Sparsable pointer

pub fn check_depth(&self, depth: u32) -> Result<(), SparseError>

Check if the current depth isn’t too much. This is the cyclic pointer protection mechanism

impl StructuralPartialEq for OApiOperation