Struct Schema

#[non_exhaustive]
pub struct Schema {

    pub type: Type,
    pub format: String,
    pub title: String,
    pub description: String,
    pub nullable: bool,
    pub default: Option<Value>,
    pub items: Option<Box<Schema>>,
    pub min_items: i64,
    pub max_items: i64,
    pub enum: Vec<String>,
    pub properties: HashMap<String, Schema>,
    pub property_ordering: Vec<String>,
    pub required: Vec<String>,
    pub min_properties: i64,
    pub max_properties: i64,
    pub minimum: f64,
    pub maximum: f64,
    pub min_length: i64,
    pub max_length: i64,
    pub pattern: String,
    pub example: Option<Value>,
    pub any_of: Vec<Schema>,
    pub additional_properties: Option<Value>,
    pub ref: String,
    pub defs: HashMap<String, Schema>,
    /* private fields */
}

Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: Type

Optional. The type of the data.

format: String

Optional. The format of the data. Supported formats: for NUMBER type: “float”, “double” for INTEGER type: “int32”, “int64” for STRING type: “email”, “byte”, etc

title: String

Optional. The title of the Schema.

description: String

Optional. The description of the data.

nullable: bool

Optional. Indicates if the value may be null.

default: Option<Value>

Optional. Default value of the data.

items: Option<Box<Schema>>

Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.

min_items: i64

Optional. Minimum number of the elements for Type.ARRAY.

max_items: i64

Optional. Maximum number of the elements for Type.ARRAY.

enum: Vec<String>

Optional. Possible values of the element of primitive type with enum format. Examples:

. We can define direction as : {type:STRING, format:enum, enum:[“EAST”, NORTH“, “SOUTH”, “WEST”]} . We can define apartment number as : {type:INTEGER, format:enum, enum:[“101”, “201”, “301”]}

properties: HashMap<String, Schema>

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.

property_ordering: Vec<String>

Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.

required: Vec<String>

Optional. Required properties of Type.OBJECT.

min_properties: i64

Optional. Minimum number of the properties for Type.OBJECT.

max_properties: i64

Optional. Maximum number of the properties for Type.OBJECT.

minimum: f64

Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER

maximum: f64

Optional. Maximum value of the Type.INTEGER and Type.NUMBER

min_length: i64

Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING

max_length: i64

Optional. Maximum length of the Type.STRING

pattern: String

Optional. Pattern of the Type.STRING to restrict a string to a regular expression.

example: Option<Value>

Optional. Example of the object. Will only populated when the object is the root.

any_of: Vec<Schema>

Optional. The value should be validated against any (one or more) of the subschemas in the list.

additional_properties: Option<Value>

Optional. Can either be a boolean or an object; controls the presence of additional properties.

ref: String

Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root defs.

For example, the following schema defines a reference to a schema node named “Pet”:

type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string

The value of the “pet” property is a reference to the schema node named “Pet”. See details in https://json-schema.org/understanding-json-schema/structuring

defs: HashMap<String, Schema>

Optional. A map of definitions for use by ref Only allowed at the root of the schema.

Implementations

impl Schema

pub fn new() -> Self

pub fn set_type<T: Into<Type>>(self, v: T) -> Self

Sets the value of r#type.

pub fn set_format<T: Into<String>>(self, v: T) -> Self

Sets the value of format.

pub fn set_title<T: Into<String>>(self, v: T) -> Self

Sets the value of title.

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

pub fn set_nullable<T: Into<bool>>(self, v: T) -> Self

Sets the value of nullable.

pub fn set_default<T: Into<Option<Value>>>(self, v: T) -> Self

Sets the value of default.

pub fn set_items<T: Into<Option<Box<Schema>>>>(self, v: T) -> Self

Sets the value of items.

pub fn set_min_items<T: Into<i64>>(self, v: T) -> Self

Sets the value of min_items.

pub fn set_max_items<T: Into<i64>>(self, v: T) -> Self

Sets the value of max_items.

pub fn set_enum<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of r#enum.

pub fn set_properties<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<Schema>,

Sets the value of properties.

pub fn set_property_ordering<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of property_ordering.

pub fn set_required<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of required.

pub fn set_min_properties<T: Into<i64>>(self, v: T) -> Self

Sets the value of min_properties.

pub fn set_max_properties<T: Into<i64>>(self, v: T) -> Self

Sets the value of max_properties.

pub fn set_minimum<T: Into<f64>>(self, v: T) -> Self

Sets the value of minimum.

pub fn set_maximum<T: Into<f64>>(self, v: T) -> Self

Sets the value of maximum.

pub fn set_min_length<T: Into<i64>>(self, v: T) -> Self

Sets the value of min_length.

pub fn set_max_length<T: Into<i64>>(self, v: T) -> Self

Sets the value of max_length.

pub fn set_pattern<T: Into<String>>(self, v: T) -> Self

Sets the value of pattern.

pub fn set_example<T: Into<Option<Value>>>(self, v: T) -> Self

Sets the value of example.

pub fn set_any_of<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Schema>,

Sets the value of any_of.

pub fn set_additional_properties<T: Into<Option<Value>>>(self, v: T) -> Self

Sets the value of additional_properties.

pub fn set_ref<T: Into<String>>(self, v: T) -> Self

Sets the value of r#ref.

pub fn set_defs<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<Schema>,

Sets the value of defs.

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 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 Message for Schema

fn typename() -> &'static str

The typename of this message.

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