ex_json_schema v0.9.3

ExJsonSchema.Schema (ex_json_schema v0.9.3) View Source

Link to this section Summary

Types

invalid_reference_error()
ref_path()
resolved()

Functions

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

Link to this section Types

Link to this type

invalid_reference_error()

View Source

Specs

invalid_reference_error() :: {:error, :invalid_reference}
Link to this type

ref_path()

View Source

Specs

ref_path() :: [:root | String.t()]
Link to this type

resolved()

View Source

Specs

resolved() ::
  ExJsonSchema.data()
  | %{
      required(String.t()) =>
        (ExJsonSchema.Schema.Root.t() ->
           {ExJsonSchema.Schema.Root.t(), resolved()})
        | ref_path()
    }
  | true
  | false

Link to this section Functions

Link to this function

decode_json(json)

View Source

Specs

decode_json(String.t()) :: {:ok, String.t()} | {:error, String.t()}
Link to this function

get_fragment(root, path)

View Source

Specs

get_fragment(
  ExJsonSchema.Schema.Root.t(),
  ref_path() | ExJsonSchema.json_path()
) ::
  {:ok, resolved()} | invalid_reference_error() | no_return()
Link to this function

get_fragment!(schema, ref)

View Source

Specs

get_fragment!(
  ExJsonSchema.Schema.Root.t(),
  ref_path() | ExJsonSchema.json_path()
) ::
  resolved() | no_return()
Link to this function

get_ref_schema(root, ref)

View Source

Specs

get_ref_schema(ExJsonSchema.Schema.Root.t(), [:root | String.t()]) ::
  ExJsonSchema.data() | no_return()
Link to this function

raise_invalid_reference_error(ref)

View Source

Specs

raise_invalid_reference_error(any()) :: no_return()
Link to this function

resolve(schema, options \\ [])

View Source

Specs

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