Struct JsonSchema 

pub struct JsonSchema {

    pub schema: Option<String>,
    pub id: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub schema_type: Option<JsonSchemaType>,
    pub format: Option<String>,
    pub properties: Option<HashMap<String, JsonSchema>>,
    pub required: Option<Vec<String>>,
    pub items: Option<Box<JsonSchema>>,
    pub additional_properties: Option<AdditionalProperties>,
    pub min_length: Option<usize>,
    pub max_length: Option<usize>,
    pub pattern: Option<String>,
    pub minimum: Option<f64>,
    pub maximum: Option<f64>,
    pub exclusive_minimum: Option<f64>,
    pub exclusive_maximum: Option<f64>,
    pub multiple_of: Option<f64>,
    pub min_items: Option<usize>,
    pub max_items: Option<usize>,
    pub unique_items: Option<bool>,
    pub enum: Option<Vec<Value>>,
    pub const: Option<Value>,
    pub reference: Option<String>,
    pub any_of: Option<Vec<JsonSchema>>,
    pub all_of: Option<Vec<JsonSchema>>,
    pub one_of: Option<Vec<JsonSchema>>,
    pub not: Option<Box<JsonSchema>>,
    pub default: Option<Value>,
    pub examples: Option<Vec<Value>>,
    pub deprecated: Option<bool>,
    pub read_only: Option<bool>,
    pub write_only: Option<bool>,
    pub defs: Option<HashMap<String, JsonSchema>>,
}

JSON Schema document (Draft 2020-12)

Fields

schema: Option<String>

id: Option<String>

title: Option<String>

description: Option<String>

schema_type: Option<JsonSchemaType>

format: Option<String>

properties: Option<HashMap<String, JsonSchema>>

required: Option<Vec<String>>

items: Option<Box<JsonSchema>>

additional_properties: Option<AdditionalProperties>

min_length: Option<usize>

max_length: Option<usize>

pattern: Option<String>

minimum: Option<f64>

maximum: Option<f64>

exclusive_minimum: Option<f64>

exclusive_maximum: Option<f64>

multiple_of: Option<f64>

min_items: Option<usize>

max_items: Option<usize>

unique_items: Option<bool>

enum: Option<Vec<Value>>

const: Option<Value>

reference: Option<String>

any_of: Option<Vec<JsonSchema>>

all_of: Option<Vec<JsonSchema>>

one_of: Option<Vec<JsonSchema>>

not: Option<Box<JsonSchema>>

default: Option<Value>

examples: Option<Vec<Value>>

deprecated: Option<bool>

read_only: Option<bool>

write_only: Option<bool>

defs: Option<HashMap<String, JsonSchema>>

Implementations

impl JsonSchema

pub fn new() -> Self

Create a new empty schema

pub fn string() -> Self

Create a string schema

pub fn integer() -> Self

Create an integer schema

pub fn number() -> Self

Create a number schema

pub fn boolean() -> Self

Create a boolean schema

pub fn array(items: JsonSchema) -> Self

Create an array schema

pub fn object() -> Self

Create an object schema

pub fn null() -> Self

Create a null schema

pub fn reference(name: &str) -> Self

Create a reference to another schema

pub fn title(self, title: impl Into<String>) -> Self

Set the title

pub fn description(self, desc: impl Into<String>) -> Self

Set the description

pub fn format(self, format: impl Into<String>) -> Self

Set the format

pub fn property(self, name: impl Into<String>, schema: JsonSchema) -> Self

Add a property to an object schema

pub fn required(self, fields: &[&str]) -> Self

Set required fields

pub fn min_length(self, min: usize) -> Self

Set minimum length for strings

pub fn max_length(self, max: usize) -> Self

Set maximum length for strings

pub fn pattern(self, pattern: impl Into<String>) -> Self

Set regex pattern for strings

pub fn minimum(self, min: impl Into<f64>) -> Self

Set minimum value for numbers

pub fn maximum(self, max: impl Into<f64>) -> Self

Set maximum value for numbers

pub fn exclusive_minimum(self, min: impl Into<f64>) -> Self

Set exclusive minimum for numbers

pub fn exclusive_maximum(self, max: impl Into<f64>) -> Self

Set exclusive maximum for numbers

pub fn multiple_of(self, divisor: impl Into<f64>) -> Self

Set multipleOf constraint for numbers

pub fn min_items(self, min: usize) -> Self

Set minimum items for arrays

pub fn max_items(self, max: usize) -> Self

Set maximum items for arrays

pub fn unique_items(self, unique: bool) -> Self

Set unique items constraint for arrays

pub fn enum_values<T: Serialize>(self, values: &[T]) -> Self

Set enum values

pub fn const_value<T: Serialize>(self, value: T) -> Self

Set a const value

pub fn default<T: Serialize>(self, value: T) -> Self

Set a default value

pub fn examples<T: Serialize>(self, values: Vec<T>) -> Self

Set example values

pub fn deprecated(self, deprecated: bool) -> Self

Mark as deprecated

pub fn read_only(self, read_only: bool) -> Self

Mark as read-only

pub fn write_only(self, write_only: bool) -> Self

Mark as write-only

pub fn any_of(schemas: Vec<JsonSchema>) -> Self

Create an anyOf schema

pub fn all_of(schemas: Vec<JsonSchema>) -> Self

Create an allOf schema

pub fn one_of(schemas: Vec<JsonSchema>) -> Self

Create a oneOf schema

pub fn negation(schema: JsonSchema) -> Self

Create a negation schema (not)

Trait Implementations

impl Clone for JsonSchema

fn clone(&self) -> JsonSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonSchema

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

Formats the value using the given formatter.

impl Default for JsonSchema

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for JsonSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.