Struct Schema

pub struct Schema {

    pub title: Option<String>,
    pub enum: Option<Vec<String>>,
    pub multiple_of: Option<Number>,
    pub maximum: Option<Number>,
    pub exclusive_maximum: Option<bool>,
    pub minimum: Option<Number>,
    pub exclusive_minimum: Option<bool>,
    pub max_length: Option<Number>,
    pub min_length: Option<Number>,
    pub pattern: Option<String>,
    pub max_items: Option<Number>,
    pub min_items: Option<Number>,
    pub unique_items: Option<bool>,
    pub items: Option<Box<RefOrObject<Schema>>>,
    pub properties: Option<BTreeMap<String, RefOrObject<Schema>>>,
    pub max_properties: Option<Number>,
    pub min_properties: Option<Number>,
    pub required: Option<Vec<String>>,
    pub type: Option<String>,
    pub all_of: Option<Vec<Box<RefOrObject<Schema>>>>,
    pub one_of: Option<Vec<Box<RefOrObject<Schema>>>>,
    pub any_of: Option<Vec<Box<RefOrObject<Schema>>>>,
    pub not: Option<Box<RefOrObject<Schema>>>,
    pub description: Option<String>,
    pub format: Option<String>,
    pub default: Option<String>,
    pub additional_properties: Option<Value>,
    pub nullable: Option<bool>,
    pub discriminator: Option<Discriminator>,
    pub read_only: Option<bool>,
    pub write_only: Option<bool>,
    pub xml: Option<XML>,
    pub external_docs: Option<ExternalDoc>,
    pub example: Option<Value>,
    pub deprecated: Option<bool>,
}

Schema

The Schema Object allows the definition of input and output data types. ser https://swagger.io/specification/v3/#schema-object

Fields

title: Option<String>

enum: Option<Vec<String>>

multiple_of: Option<Number>

maximum: Option<Number>

exclusive_maximum: Option<bool>

minimum: Option<Number>

exclusive_minimum: Option<bool>

max_length: Option<Number>

min_length: Option<Number>

pattern: Option<String>

max_items: Option<Number>

min_items: Option<Number>

unique_items: Option<bool>

items: Option<Box<RefOrObject<Schema>>>

properties: Option<BTreeMap<String, RefOrObject<Schema>>>

max_properties: Option<Number>

min_properties: Option<Number>

required: Option<Vec<String>>

type: Option<String>

all_of: Option<Vec<Box<RefOrObject<Schema>>>>

one_of: Option<Vec<Box<RefOrObject<Schema>>>>

any_of: Option<Vec<Box<RefOrObject<Schema>>>>

not: Option<Box<RefOrObject<Schema>>>

description: Option<String>

format: Option<String>

default: Option<String>

additional_properties: Option<Value>

nullable: Option<bool>

discriminator: Option<Discriminator>

Adds support for polymorphism.

read_only: Option<bool>

Relevant only for Schema “properties” definitions.

write_only: Option<bool>

Relevant only for Schema “properties” definitions.

xml: Option<XML>

This MAY be used only on properties schemas.

external_docs: Option<ExternalDoc>

Additional external documentation for this schema.

example: Option<Value>

A free-form property to include an example of an instance for this schema.

deprecated: Option<bool>

Specifies that a schema is deprecated and SHOULD be transitioned out of usage.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Schema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Schema

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

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 Schema