Pipeline.Validation.SchemaValidator (pipeline v0.0.1)

JSON Schema-based validation for pipeline step outputs.

Provides comprehensive validation of step outputs against JSON schemas, ensuring structured data exchange between pipeline steps.

Summary

Types

schema()

validation_error()

validation_errors()

validation_result()

Functions

supported_types()

Get supported JSON Schema types.

valid_schema?(schema)

Check if a schema is valid JSON Schema format.

validate(data, schema)

Validate data against a JSON schema.

validate_step_output(step_name, data, schema)

Validate step output with detailed error reporting.

Types

schema()

@type schema() :: map()

validation_error()

@type validation_error() :: %{
  path: String.t(),
  message: String.t(),
  value: any(),
  schema: map()
}

validation_errors()

@type validation_errors() :: [validation_error()]

validation_result()

@type validation_result() :: {:ok, any()} | {:error, validation_errors()}

Functions

supported_types()

@spec supported_types() :: [String.t()]

Get supported JSON Schema types.

valid_schema?(schema)

@spec valid_schema?(schema()) :: boolean()

Check if a schema is valid JSON Schema format.

validate(data, schema)

@spec validate(any(), schema()) :: validation_result()

Validate data against a JSON schema.

Examples

iex> schema = %{"type" => "object", "required" => ["name"], "properties" => %{"name" => %{"type" => "string"}}}
iex> data = %{"name" => "test"}
iex> Pipeline.Validation.SchemaValidator.validate(data, schema)
{:ok, %{"name" => "test"}}

iex> data = %{"age" => 25}
iex> Pipeline.Validation.SchemaValidator.validate(data, schema)
{:error, [%{path: "", message: "Required property 'name' is missing", value: %{"age" => 25}, schema: schema}]}

validate_step_output(step_name, data, schema)

@spec validate_step_output(String.t(), any(), schema()) ::
  {:ok, any()} | {:error, String.t(), validation_errors()}

Validate step output with detailed error reporting.

Returns a structured result with validation status and detailed error information.