Struct JsonSchema 

pub struct JsonSchema {

    pub schema: String,
    pub id: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub schema_type: String,
    pub properties: Option<HashMap<String, JsonSchema>>,
    pub required: Option<Vec<String>>,
    pub items: Option<Box<JsonSchema>>,
    pub enum_values: Option<Vec<Value>>,
    pub additional_properties: Option<Box<JsonSchema>>,
    pub definitions: Option<HashMap<String, JsonSchema>>,
    pub minimum: Option<f64>,
    pub maximum: Option<f64>,
    pub pattern: Option<String>,
    pub format: Option<String>,
    pub one_of: Option<Vec<JsonSchema>>,
    pub any_of: Option<Vec<JsonSchema>>,
    pub all_of: Option<Vec<JsonSchema>>,
    pub reference: Option<String>,
}

JSON Schema document

Fields

schema: String

Schema version (always “https://json-schema.org/draft/2020-12/schema”)

id: Option<String>

Schema identifier

title: Option<String>

Schema title

description: Option<String>

Schema description

schema_type: String

Type of the schema

properties: Option<HashMap<String, JsonSchema>>

Properties for object types

required: Option<Vec<String>>

Required property names

items: Option<Box<JsonSchema>>

Items schema for array types

enum_values: Option<Vec<Value>>

Enum values for enums

additional_properties: Option<Box<JsonSchema>>

Additional properties

definitions: Option<HashMap<String, JsonSchema>>

Schema definitions

minimum: Option<f64>

Minimum value for numbers

maximum: Option<f64>

Maximum value for numbers

pattern: Option<String>

Pattern for strings

format: Option<String>

Format for strings

one_of: Option<Vec<JsonSchema>>

One of (union types)

any_of: Option<Vec<JsonSchema>>

Any of (union types with overlap)

all_of: Option<Vec<JsonSchema>>

All of (intersection types)

reference: Option<String>

Reference to another schema

Implementations

impl JsonSchema

pub fn new(schema_type: &str) -> Self

Create a new empty schema

pub fn string() -> Self

Create a string schema

pub fn number() -> Self

Create a number schema

pub fn integer() -> Self

Create an integer 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 reference(ref_path: &str) -> Self

Create a reference schema

pub fn with_title(self, title: String) -> Self

Set title

pub fn with_description(self, description: String) -> Self

Set description

pub fn with_id(self, id: String) -> Self

Set ID

pub fn add_property(&mut self, name: String, schema: JsonSchema)

Add a property to an object schema

pub fn add_required(&mut self, name: String)

Add a required property

pub fn with_enum(self, values: Vec<Value>) -> Self

Set enum values

pub fn with_pattern(self, pattern: String) -> Self

Set pattern for strings

pub fn with_format(self, format: String) -> Self

Set format for strings

pub fn add_definition(&mut self, name: String, schema: JsonSchema)

Add a definition

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