Struct openapi_rocketapi::v3_0::Schema

pub struct Schema {
    pub ref_path: Option<String>,
    pub description: Option<String>,
    pub schema_type: Option<String>,
    pub format: Option<String>,
    pub enum_values: Option<Vec<String>>,
    pub required: Option<Vec<String>>,
    pub items: Option<Box<Schema>>,
    pub properties: Option<BTreeMap<String, Schema>>,
    pub read_only: Option<bool>,
    pub additional_properties: Option<ObjectOrReference<Box<Schema>>>,
    pub example: Option<Value>,
    pub title: Option<String>,
    pub default: Option<Value>,
    pub minimum: Option<Value>,
    pub maximum: Option<Value>,
    pub all_of: Option<Vec<ObjectOrReference<Schema>>>,
}

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.

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#schemaObject.

Fields

ref_path: Option<String>

JSON reference path to another definition

description: Option<String>

schema_type: Option<String>

format: Option<String>

enum_values: Option<Vec<String>>

required: Option<Vec<String>>

items: Option<Box<Schema>>

properties: Option<BTreeMap<String, Schema>>

read_only: Option<bool>

additional_properties: Option<ObjectOrReference<Box<Schema>>>

Value can be boolean or object. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#properties.

example: Option<Value>

A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. NOTE: According to [spec], Primitive data types in the OAS are based on the types supported by the JSON Schema Specification Wright Draft 00. This suggest using serde_json::Value. [spec][https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#data-types]

title: Option<String>

default: Option<Value>

The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level. For example, if type is string, then default can be "foo" but cannot be 1.

minimum: Option<Value>

maximum: Option<Value>

all_of: Option<Vec<ObjectOrReference<Schema>>>

Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.

Trait Implementations

impl Default for Schema

fn default() -> Schema

Returns the "default value" for a type.

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

fn eq(&self, other: &Schema) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Schema) -> bool

This method tests for !=.

impl Debug for Schema

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

Formats the value using the given formatter.

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<'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.