json_xema

v0.1.3

json_xema v0.1.3 JsonXema View Source

A JSON Schema validator.

Link to this section Summary

Types

t()

Functions

init(bool)

This callback initialize the schema. The function gets the data given to Xema.new/1 and returns a Xema.Schema

is_valid?(schema, value) deprecated

Returns true if the value is a valid value against the given schema; otherwise returns false

new(data, opts \\ [])

This function creates a new JsonXema from the given schema

to_xema(json_xema)

Converts a %JsonXema{} into a %Xema{}

valid?(schema, value)

Returns true if the value is a valid value against the given schema; otherwise returns false

validate(schema, value)

Returns :ok if the value is a valid value against the given schema; otherwise returns an error tuple

validate!(xema, value)

Returns :ok if the value is a valid value against the given schema; otherwise raises a Xema.ValidationError

Link to this section Types

Link to this type

t() View Source 
t() :: %JsonXema{refs: any(), schema: any()}

Link to this section Functions

Link to this function

init(bool) View Source 
init(boolean() | map()) :: Xema.Schema.t()

This callback initialize the schema. The function gets the data given to Xema.new/1 and returns a Xema.Schema.

Callback implementation for Xema.Behaviour.init/1.

Link to this function

is_valid?(schema, value) View Source 
is_valid?(JsonXema.t() | Xema.Schema.t(), any()) :: boolean()

This function is deprecated. Use valid? instead.

Returns true if the value is a valid value against the given schema; otherwise returns false.

Link to this function

new(data, opts \\ []) View Source 
new(String.t() | map(), atom()) :: %JsonXema{refs: term(), schema: term()}

This function creates a new JsonXema from the given schema.

Possible options:

  • :resolver - a resolver for remote schemas. This option will overwrite the resolver from the config. See Configure a resolver to how to define a resolver.

Examples 

iex> ~s({"type": "string"})
...> |> Jason.decode!()
...> |> JsonXema.new()
%JsonXema{refs: %{}, schema: %Xema.Schema{type: :string}}
Link to this function

to_xema(json_xema) View Source 
to_xema(%JsonXema{refs: term(), schema: term()}) :: %Xema{
  refs: term(),
  schema: term()
}

Converts a %JsonXema{} into a %Xema{}.

Link to this function

valid?(schema, value) View Source 
valid?(JsonXema.t() | Xema.Schema.t(), any()) :: boolean()

Returns true if the value is a valid value against the given schema; otherwise returns false.

Link to this function

validate(schema, value) View Source 
validate(JsonXema.t() | Xema.Schema.t(), any()) :: Xema.Validator.result()

Returns :ok if the value is a valid value against the given schema; otherwise returns an error tuple.

Link to this function

validate!(xema, value) View Source 
validate!(JsonXema.t() | Xema.Schema.t(), any()) :: :ok

Returns :ok if the value is a valid value against the given schema; otherwise raises a Xema.ValidationError.