Struct VariableSchema 

pub struct VariableSchema { /* private fields */ }

Variable schema for workflow variables using JSON Schema format.

This allows flows to declare required variables with their types, default values, descriptions, secret annotations, and environment variable mappings.

Example:

variables:
  type: object
  properties:
    api_key:
      type: string
      is_secret: true
      env_var: "OPENAI_API_KEY"
      description: "OpenAI API key"
    temperature:
      type: number
      default: 0.7
      minimum: 0
      maximum: 2
  required: ["api_key"]

Implementations

impl VariableSchema

pub fn new(schema: SchemaRef) -> Self

Create a new variable schema from a JSON Schema.

pub fn secrets(&self) -> &Secrets

pub fn variables(&self) -> &[String]

Return variable names from the schema properties.

pub fn env_var_name(&self, variable_name: &str) -> Option<&str>

Get the environment variable name for a given variable, if annotated.

pub fn env_var_map(&self) -> &HashMap<String, String>

Get the full mapping of variable names to environment variable names.

pub fn required_variables(&self) -> impl Iterator<Item = &str> + '_

Get the list of required variables.

pub fn default_value(&self, variable_name: &str) -> Option<ValueRef>

Get the default value for a variable, if specified.

pub fn validate_variables( &self, variables: &HashMap<String, Value>, ) -> Result<(), VariableValidationError>

Validate that provided variable values match the schema requirements.

Trait Implementations

impl Clone for VariableSchema

fn clone(&self) -> VariableSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VariableSchema

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

Formats the value using the given formatter.

impl Default for VariableSchema

fn default() -> VariableSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VariableSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SchemaRef> for VariableSchema

fn from(schema: SchemaRef) -> Self

Converts to this type from the input type.

impl From<VariableSchema> for SchemaRef

fn from(var_schema: VariableSchema) -> Self

Converts to this type from the input type.

impl JsonSchema for VariableSchema

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for VariableSchema

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

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 VariableSchema