Struct ConfigPropertySchema 

pub struct ConfigPropertySchema {
    pub type: String,
    pub title: String,
    pub description: Option<String>,
    pub default: Option<AnyValue>,
    pub enum: Option<Vec<AnyValue>>,
    pub enum_labels: Option<Vec<String>>,
    pub enum_descriptions: Option<Vec<String>>,
    pub read_only: Option<bool>,
    pub items: Option<Box<ConfigPropertySchema>>,
    pub properties: Option<HashMap<String, Box<ConfigPropertySchema>>>,
    pub required: Option<Vec<String>>,
    pub additional_properties: Option<Box<ConfigPropertySchema>>,
}

A JSON Schema-compatible property descriptor with display extensions.

Standard JSON Schema fields (type, title, description, default, enum) allow validators to process the schema. Display extensions (enumLabels, enumDescriptions) are parallel arrays that provide UI metadata for each enum value.

This is the generic base type. See {@link SessionConfigPropertySchema} for session-specific extensions.

Fields

type: String

JSON Schema: property type

title: String

JSON Schema: human-readable label for the property

description: Option<String>

JSON Schema: description / tooltip

default: Option<AnyValue>

JSON Schema: default value

enum: Option<Vec<AnyValue>>

JSON Schema: allowed values. May be primitives of any JSON type.

enum_labels: Option<Vec<String>>

Display extension: human-readable label per enum value (parallel array)

enum_descriptions: Option<Vec<String>>

Display extension: description per enum value (parallel array)

read_only: Option<bool>

JSON Schema: when true, the property is displayed but cannot be modified by the user

items: Option<Box<ConfigPropertySchema>>

JSON Schema: schema for array items (used when type is 'array')

properties: Option<HashMap<String, Box<ConfigPropertySchema>>>

JSON Schema: property descriptors for object properties (used when type is 'object')

required: Option<Vec<String>>

JSON Schema: list of required property ids (used when type is 'object')

additional_properties: Option<Box<ConfigPropertySchema>>

JSON Schema: schema for additional properties not listed in properties (used when type is 'object').

Trait Implementations

impl Clone for ConfigPropertySchema

fn clone(&self) -> ConfigPropertySchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigPropertySchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigPropertySchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConfigPropertySchema

fn eq(&self, other: &ConfigPropertySchema) -> 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 ConfigPropertySchema

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 ConfigPropertySchema