ExJsonSchema.Schema (ex_json_schema v0.11.0)

View Source

Summary

Types

invalid_reference_error()
resolved()

Functions

decode_json(json)
get_fragment(root, ref)
get_fragment!(root, ref)
get_ref_schema(root, ref)
raise_invalid_reference_error(ref)
resolve(schema, options \\ [])

Types

invalid_reference_error()

@type invalid_reference_error() :: {:error, :invalid_reference}

resolved()

@type resolved() :: ExJsonSchema.data()

Functions

decode_json(json)

@spec decode_json(String.t()) :: {:ok, String.t()} | {:error, String.t()}

get_fragment(root, ref)

@spec get_fragment(
  ExJsonSchema.Schema.Root.t(),
  ExJsonSchema.Schema.Ref.t() | ExJsonSchema.json_path()
) ::
  {:ok, resolved()} | invalid_reference_error() | no_return()

get_fragment!(root, ref)

@spec get_fragment!(
  ExJsonSchema.Schema.Root.t(),
  ExJsonSchema.Schema.Ref.t() | ExJsonSchema.json_path()
) :: resolved() | no_return()

get_ref_schema(root, ref)

@spec get_ref_schema(ExJsonSchema.Schema.Root.t(), ExJsonSchema.Schema.Ref.t()) ::
  ExJsonSchema.data() | no_return()

raise_invalid_reference_error(ref)

@spec raise_invalid_reference_error(any()) :: no_return()

resolve(schema, options \\ [])

@spec resolve(boolean() | ExJsonSchema.Schema.Root.t() | ExJsonSchema.object(), [
  {:custom_format_validator, {module(), atom()}}
]) :: ExJsonSchema.Schema.Root.t() | no_return()