Struct SessionConfigPropertySchema 

pub struct SessionConfigPropertySchema {

    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<ConfigPropertySchema>,
    pub properties: Option<HashMap<String, ConfigPropertySchema>>,
    pub required: Option<Vec<String>>,
    pub additional_properties: Option<ConfigPropertySchema>,
    pub enum_dynamic: Option<bool>,
    pub session_mutable: Option<bool>,
}

A session configuration property descriptor.

Extends the generic {@link ConfigPropertySchema} with session-specific display 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<ConfigPropertySchema>

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

properties: Option<HashMap<String, 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<ConfigPropertySchema>

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

enum_dynamic: Option<bool>

Display extension: when true, the full set of allowed values is too large to enumerate statically. The client SHOULD use sessionConfigCompletions to fetch matching values based on user input. Any values in enum are seed/recent values for initial display.

session_mutable: Option<bool>

When true, the user may change this property after session creation

Trait Implementations

impl Clone for SessionConfigPropertySchema

fn clone(&self) -> SessionConfigPropertySchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionConfigPropertySchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionConfigPropertySchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SessionConfigPropertySchema

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

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 SessionConfigPropertySchema