Struct Spec

pub struct Spec {

    pub spec_version: String,
    pub info: Info,
    pub servers: Vec<Server>,
    pub paths: HashMap<String, RefOr<PathItem>>,
    pub components: Option<Components>,
    pub security: Vec<HashMap<String, Vec<String>>>,
    pub tags: Vec<Tag>,
    pub external_docs: Option<ExternalDocumentation>,
    pub x_fields: HashMap<String, Value>,
    pub host: Option<String>,
    pub base_path: Option<String>,
    pub schemes: Vec<Scheme>,
    pub consumes: Vec<String>,
    pub produces: Vec<String>,
    pub definitions: HashMap<String, RefOr<Schema>>,
    pub parameters: HashMap<String, RefOr<Parameter>>,
    pub responses: HashMap<String, RefOr<Response>>,
    pub security_definitions: HashMap<String, RefOr<SecurityScheme>>,
    pub json_schema_dialect: Option<String>,
    pub webhooks: HashMap<String, RefOr<PathItem>>,
}

Fields

spec_version: String

info: Info

servers: Vec<Server>

paths: HashMap<String, RefOr<PathItem>>

components: Option<Components>

security: Vec<HashMap<String, Vec<String>>>

tags: Vec<Tag>

external_docs: Option<ExternalDocumentation>

x_fields: HashMap<String, Value>

Allows extensions to the Swagger Schema. The field name MUST begin with x-, for example, x-internal-id. The value can be null, a primitive, an array or an object. See Vendor Extensions for further details.

host: Option<String>

base_path: Option<String>

schemes: Vec<Scheme>

consumes: Vec<String>

produces: Vec<String>

definitions: HashMap<String, RefOr<Schema>>

parameters: HashMap<String, RefOr<Parameter>>

responses: HashMap<String, RefOr<Response>>

security_definitions: HashMap<String, RefOr<SecurityScheme>>

json_schema_dialect: Option<String>

webhooks: HashMap<String, RefOr<PathItem>>

Implementations

impl Spec

pub fn schemas(&self) -> HashMap<String, RefOr<Schema>>

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Spec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spec

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

Formats the value using the given formatter.

impl Default for Spec

fn default() -> Spec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Spec

where Spec: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Spec

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Spec