Struct FlowSchema 

pub struct FlowSchema {
    pub defs: HashMap<String, SchemaRef>,
    pub input: Option<SchemaRef>,
    pub output: Option<SchemaRef>,
    pub variables: Option<SchemaRef>,
    pub steps: IndexMap<String, SchemaRef>,
}

Consolidated schema information for a flow.

This struct contains all schema/type information for the flow in a single location, allowing shared $defs across all schemas and avoiding duplication.

Serializes as a valid JSON Schema with type: "object" and flow-specific properties (input, output, variables, steps) under the properties key.

Fields

defs: HashMap<String, SchemaRef>

Shared type definitions that can be referenced by other schemas. References use the format #/schemas/$defs/TypeName.

input: Option<SchemaRef>

The input schema for the flow.

output: Option<SchemaRef>

The output schema for the flow.

variables: Option<SchemaRef>

Schema for workflow variables. This is a JSON Schema object where properties define the available variables and their types.

steps: IndexMap<String, SchemaRef>

Output schemas for each step, keyed by step ID. Note: Step input schemas are not included here as they are component metadata, not flow-specific schemas. Uses IndexMap to preserve insertion order for deterministic serialization.

Implementations

impl FlowSchema

pub fn is_empty(&self) -> bool

Returns true if all fields are empty/None.

Trait Implementations

impl Clone for FlowSchema

fn clone(&self) -> FlowSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlowSchema

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

Formats the value using the given formatter.

impl Default for FlowSchema

fn default() -> FlowSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FlowSchema

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for FlowSchema

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 FlowSchema

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

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 FlowSchema