ExJsonSchema.Validator behaviour (ex_json_schema v0.11.1)

View Source

Summary

Types

errors()
options()

Callbacks

validate(t, data, {}, data, json_path)

Functions

do_validation_errors(root, schema, data, path)
map_to_invalid_errors(errors_with_index)
valid?(root, data)
valid_fragment?(root, schema_or_ref, data)
validate(root, data, options \\ [])
validate_fragment(root, schema_or_ref, data, options \\ [])
validation_errors(root, schema_or_ref, data, path \\ "#")

Types

errors()

@type errors() ::
  [%ExJsonSchema.Validator.Error{error: term(), path: term()}] | list()

options()

@type options() :: [{:error_formatter, module() | false}]

Callbacks

validate(t, data, {}, data, json_path)

@callback validate(
  ExJsonSchema.Schema.Root.t(),
  ExJsonSchema.data(),
  {String.t(), ExJsonSchema.data()},
  ExJsonSchema.data(),
  ExJsonSchema.json_path()
) :: errors()

Functions

do_validation_errors(root, schema, data, path)

map_to_invalid_errors(errors_with_index)

valid?(root, data)

@spec valid?(
  ExJsonSchema.Schema.Root.t() | ExJsonSchema.object(),
  ExJsonSchema.data()
) ::
  boolean() | no_return()

valid_fragment?(root, schema_or_ref, data)

@spec valid_fragment?(
  ExJsonSchema.Schema.Root.t(),
  ExJsonSchema.json_path() | ExJsonSchema.Schema.resolved(),
  ExJsonSchema.data()
) :: boolean() | ExJsonSchema.Schema.invalid_reference_error() | no_return()

validate(root, data, options \\ [])

validate_fragment(root, schema_or_ref, data, options \\ [])

@spec validate_fragment(
  ExJsonSchema.Schema.Root.t(),
  ExJsonSchema.json_path() | ExJsonSchema.Schema.resolved(),
  ExJsonSchema.data(),
  options()
) ::
  :ok
  | {:error, errors()}
  | ExJsonSchema.Schema.invalid_reference_error()
  | no_return()

validation_errors(root, schema_or_ref, data, path \\ "#")

@spec validation_errors(
  ExJsonSchema.Schema.Root.t(),
  ExJsonSchema.json_path() | ExJsonSchema.Schema.resolved(),
  ExJsonSchema.data(),
  String.t()
) :: errors() | ExJsonSchema.Schema.invalid_reference_error() | no_return()