Struct SchemaProperty 

pub struct SchemaProperty {
    pub property_type: Option<Value>,
    pub description: Option<String>,
    pub format: Option<String>,
    pub items: Option<Box<SchemaProperty>>,
    pub properties: Option<HashMap<String, SchemaProperty>>,
    pub required: Option<Vec<String>>,
    pub default: Option<Value>,
    pub enum_values: Option<Vec<Value>>,
    pub reference: Option<String>,
    pub additional: HashMap<String, Value>,
}

A property definition in a schema

Fields

property_type: Option<Value>

The type of this property (can be a single type or array of types for nullable)

description: Option<String>

Description of this property

format: Option<String>

Format hint (e.g., “uuid”, “date-time”, “email”)

items: Option<Box<SchemaProperty>>

For array types, the schema of items

properties: Option<HashMap<String, SchemaProperty>>

For object types, nested properties

required: Option<Vec<String>>

Required properties (for object types)

default: Option<Value>

Default value for this property

enum_values: Option<Vec<Value>>

Enum values if this is an enum

reference: Option<String>

Reference to another schema definition

additional: HashMap<String, Value>

Any additional property metadata

Implementations

impl SchemaProperty

pub fn string() -> Self

Create a string property

pub fn uuid() -> Self

Create a UUID property (string with format)

pub fn integer() -> Self

Create an integer property

pub fn object() -> Self

Create an object property

pub fn array(items: SchemaProperty) -> Self

Create an array property

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

Add a description

pub fn with_default(self, default: Value) -> Self

Add a default value

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

Add nested properties (for object types)

Trait Implementations

impl Clone for SchemaProperty

fn clone(&self) -> SchemaProperty

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaProperty

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SchemaProperty

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SchemaProperty

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

where __S: Serializer,

Serialize this value into the given Serde serializer.