Struct oapi::OApiDocument

pub struct OApiDocument { /* fields omitted */ }

The OpenApi document root object

Implementations

impl OApiDocument

pub fn openapi(&self) -> &Version

The OAPI version used. Needs to be 3^

pub fn info(&self) -> &OApiInfo

Info about the current document

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

List of servers used in this document

pub fn paths(&self) -> &HashMap<String, OApiPathItem>

List of paths this documents defines.

pub fn components(&self) -> &Option<OApiComponents>

An optional object containing components re-used across the document

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

The security used for this API

pub fn tags(&self) -> &Option<Vec<OApiTag>>

Tags used to categorize the operations of this document

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

Link to some external documentation, if any

impl OApiDocument

pub fn get_operation_id(&self, opid_searched: &str) -> Option<&OApiOperation>

Get an operation providing its Id

Trait Implementations

impl Clone for OApiDocument

fn clone(&self) -> OApiDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OApiDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OApiDocument

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

Deserialize this value from the given Serde deserializer.

impl OApiCheckTrait for OApiDocument

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 OApiDocument

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<OApiDocument> for OApiDocument

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

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

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

This method tests for !=.

impl Serialize for OApiDocument

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 OApiDocument

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 OApiDocument