Struct OpenApiSchema 

pub struct OpenApiSchema {
    pub openapi: String,
    pub info: Option<Value>,
    pub paths: Paths,
    pub components: Option<Value>,
    pub security: Option<Value>,
}

OpenAPI schema

This is the main schema for the OpenAPI specification.

Fields

openapi: String

The OpenAPI version

This is the version of the OpenAPI specification.

info: Option<Value>

The info

This is the info of the OpenAPI specification.

paths: Paths

The paths

This is the paths of the OpenAPI specification.

Paths are indexed by route and method.

Example:

{
    "/path/to/route": {
        "get": {
            "operationId": "get_record"
        },
        "post": {
            "operationId": "create_record"
        }
    }
}

components: Option<Value>

The components

This is the components of the OpenAPI specification.

security: Option<Value>

The security

This is the security of the OpenAPI specification.

Implementations

impl OpenApiSchema

pub fn load_doc_from_string( content: &str, ) -> Result<OpenApiSchema, MappedErrors>

pub fn resolve_input_refs_from_operation_id( &self, operation_id: &str, ) -> Result<Value, MappedErrors>

Resolve the input refs

This function resolves the references from input elements like parameters, request bodies, headers, etc.

Client methods should simple call this method with the operation id and the input element name.

Trait Implementations

impl Clone for OpenApiSchema

fn clone(&self) -> OpenApiSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenApiSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpenApiSchema

fn eq(&self, other: &OpenApiSchema) -> 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 OpenApiSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OpenApiSchema

impl StructuralPartialEq for OpenApiSchema