Struct Schema

pub struct Schema {

    pub format: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub default: Option<Value>,
    pub multiple_of: Option<u64>,
    pub maximum: Option<i64>,
    pub exclusive_maximum: Option<i64>,
    pub minimum: Option<i64>,
    pub exclusive_minimum: Option<i64>,
    pub max_length: Option<u64>,
    pub min_length: Option<u64>,
    pub pattern: Option<String>,
    pub max_items: Option<u64>,
    pub min_items: Option<u64>,
    pub unique_items: Option<bool>,
    pub max_properties: Option<u64>,
    pub min_properties: Option<u64>,
    pub required: Vec<String>,
    pub enum_values: Vec<Value>,
    pub schema_type: Option<SchemaType>,
    pub items: Option<RefOr<Box<Self>>>,
    pub all_of: Vec<RefOr<Box<Self>>>,
    pub properties: HashMap<String, RefOr<Box<Self>>>,
    pub additional_properties: Option<RefOr<Box<Self>>>,
    pub discriminator: Option<StringOrDiscriminator>,
    pub read_only: Option<bool>,
    pub xml: Option<XML>,
    pub external_docs: Option<ExternalDocumentation>,
    pub example: Option<Value>,
    pub x_fields: HashMap<String, Value>,
    pub one_of: Vec<RefOr<Box<Self>>>,
    pub any_of: Vec<RefOr<Box<Self>>>,
    pub not: Option<RefOr<Box<Self>>>,
    pub nullable: Option<bool>,
    pub write_only: Option<bool>,
    pub deprecated: Option<bool>,
}

Schema Object

The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00.

For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema.

Fields

format: Option<String>

title: Option<String>

description: Option<String>

default: Option<Value>

multiple_of: Option<u64>

maximum: Option<i64>

exclusive_maximum: Option<i64>

minimum: Option<i64>

exclusive_minimum: Option<i64>

max_length: Option<u64>

min_length: Option<u64>

pattern: Option<String>

max_items: Option<u64>

min_items: Option<u64>

unique_items: Option<bool>

max_properties: Option<u64>

min_properties: Option<u64>

required: Vec<String>

enum_values: Vec<Value>

schema_type: Option<SchemaType>

items: Option<RefOr<Box<Self>>>

all_of: Vec<RefOr<Box<Self>>>

properties: HashMap<String, RefOr<Box<Self>>>

additional_properties: Option<RefOr<Box<Self>>>

discriminator: Option<StringOrDiscriminator>

read_only: Option<bool>

xml: Option<XML>

external_docs: Option<ExternalDocumentation>

example: Option<Value>

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.

one_of: Vec<RefOr<Box<Self>>>

any_of: Vec<RefOr<Box<Self>>>

not: Option<RefOr<Box<Self>>>

nullable: Option<bool>

write_only: Option<bool>

deprecated: Option<bool>

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate 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 Default for Schema

fn default() -> Schema

Returns the “default value” for a type.

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

where Schema: 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 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 Resolvable for Schema

fn resolve(spec: &Spec, path: &String) -> Result<Self, ResolveError>

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