ex_json_schema

v0.7.4

ex_json_schema v0.7.4 ExJsonSchema.Validator

Link to this section Summary

Types

errors()
options()

Functions

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 \\ "#")

Link to this section Types

Link to this type

errors()

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

options()

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

Link to this section Functions

Link to this function

valid?(root, data)

valid?(
  ExJsonSchema.Schema.Root.t() | ExJsonSchema.object(),
  ExJsonSchema.data()
) :: boolean() | no_return()
Link to this function

valid_fragment?(root, schema_or_ref, data)

valid_fragment?(
  ExJsonSchema.Schema.Root.t(),
  ExJsonSchema.json_path() | ExJsonSchema.Schema.resolved(),
  ExJsonSchema.data()
) :: boolean() | ExJsonSchema.Schema.invalid_reference_error() | no_return()
Link to this function

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

Link to this function

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

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()
Link to this function

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

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