Exdantic.Runtime.Validator (exdantic v0.0.2)

View Source

Validation functions specifically for runtime schemas.

This module provides validation logic that works with both DynamicSchema and EnhancedSchema, handling the full validation pipeline including model validators and computed fields.

Summary

Functions

enhance_schema(dynamic_schema, opts \\ [])

Converts a DynamicSchema to an EnhancedSchema.

enhanced_schema?(arg1)

Checks if a schema supports enhanced features.

schema_info(schema)

Returns information about a runtime schema.

to_json_schema(schema, opts \\ [])

Generates JSON Schema for a runtime schema.

validate(data, schema, opts \\ [])

Validates data against a runtime schema (DynamicSchema or EnhancedSchema).

validate!(data, schema, opts \\ [])

Validates data against a runtime schema, raising on failure.

Functions

enhance_schema(dynamic_schema, opts \\ [])

@spec enhance_schema(
  Exdantic.Runtime.DynamicSchema.t(),
  keyword()
) :: Exdantic.Runtime.EnhancedSchema.t()

Converts a DynamicSchema to an EnhancedSchema.

Parameters

  • dynamic_schema - DynamicSchema to convert
  • opts - Options for enhancement

Options

  • :model_validators - Model validators to add
  • :computed_fields - Computed fields to add

Returns

  • EnhancedSchema struct

enhanced_schema?(arg1)

@spec enhanced_schema?(
  Exdantic.Runtime.DynamicSchema.t()
  | Exdantic.Runtime.EnhancedSchema.t()
) ::
  boolean()

Checks if a schema supports enhanced features.

Parameters

  • schema - DynamicSchema or EnhancedSchema struct

Returns

  • true if schema supports enhanced features, false otherwise

schema_info(schema)

@spec schema_info(
  Exdantic.Runtime.DynamicSchema.t()
  | Exdantic.Runtime.EnhancedSchema.t()
) :: map()

Returns information about a runtime schema.

Parameters

  • schema - DynamicSchema or EnhancedSchema struct

Returns

  • Map with schema information

to_json_schema(schema, opts \\ [])

@spec to_json_schema(
  Exdantic.Runtime.DynamicSchema.t() | Exdantic.Runtime.EnhancedSchema.t(),
  keyword()
) :: map()

Generates JSON Schema for a runtime schema.

Parameters

  • schema - DynamicSchema or EnhancedSchema struct
  • opts - JSON Schema generation options

Returns

  • JSON Schema map

validate(data, schema, opts \\ [])

@spec validate(
  map(),
  Exdantic.Runtime.DynamicSchema.t() | Exdantic.Runtime.EnhancedSchema.t(),
  keyword()
) :: {:ok, map()} | {:error, [Exdantic.Error.t()]}

Validates data against a runtime schema (DynamicSchema or EnhancedSchema).

Parameters

  • data - The data to validate
  • schema - DynamicSchema or EnhancedSchema struct
  • opts - Validation options

Returns

  • {:ok, validated_data} on success
  • {:error, errors} on validation failure

validate!(data, schema, opts \\ [])

@spec validate!(
  map(),
  Exdantic.Runtime.DynamicSchema.t() | Exdantic.Runtime.EnhancedSchema.t(),
  keyword()
) :: map()

Validates data against a runtime schema, raising on failure.

Parameters

  • data - The data to validate
  • schema - DynamicSchema or EnhancedSchema struct
  • opts - Validation options

Returns