ex_json_schema v0.8.1 ExJsonSchema.Schema View Source

Link to this section Summary

Link to this section Types

Link to this type

invalid_reference_error()

View Source

Specs

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

Specs

ref_path() :: [:root | String.t()]

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

Specs

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

get_fragment(root, path)

View Source

Specs

Link to this function

get_fragment!(schema, ref)

View Source

Specs

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()