# Exonerate
**A JSONSchema -> Elixir module code generator**
Currently supports JSONSchema draft 0.7. *except:*
- integer filters do not match exact integer floating point values.
- multipleOf is not supported for number types. This is because
elixir does not support a floating point remainder guard, and also
because it is impossible for a floating point to guarantee sane results
(e.g. for IEEE Float64, `1.2 / 0.1 != 12`)
- currently remoteref is not supported.
Works in progress:
- support for remoteref
- support for unevaluatedItems, unevaluatedProperties
- support for contentMediaType
- support for contentEncoding
- support for named anchors
- better uri support
- support for defp
- support for function_from_file
- support for function_from_map
- support for more formatted strings
Note:
- by default, ALL strings are considered to be invalid unless they are valid
UTF-8 encodings and will be validated. If you require a raw binary, (for example
if you are ingesting raw data in `multipart/form-encoded`, use the
`{"format": "binary"}` filter on your string.
- some parts of the public API e.g. function_from_* options may change to better
suit the standard.
String formatting included:
- date-time
- date
- time
- ipv4
- ipv6
## Installation
Add the following lines to your mix.exs
```elixir
defp deps do
[
{:exonerate, "~> 0.1", runtime: false},
]
end
```
## Quick Start
```elixir
defmodule SchemaModule do
require Exonerate
@doc """
validates our input
"""
Exonerate.function_from_string(:def, :validate_input, """
{
"type":"object",
"properties":{
"parameter":{"type":"integer"}
}
}
""")
end
```
```
iex> SchemaModule.validate_input("some string")
{:error, schema_pointer: "#", error_value: "some string", json_pointer: "#/parameter"}}
iex> SchemaModule.validate_input(%{"parameter" => "2"})
{:error, schema_pointer: "#/properties/parameter", error_value: "2", json_pointer: "#/parameter"}}
iex> SchemaModule.validate_input(%{"parameter" => 2})
:ok
```