Data.JSON.Schema.Combinators

Combinators for creating JSON schemas.

Documentation

type SchemaC = Schema -> Schema

A schema combinator.

(<|>) :: Schema -> Schema -> Schema infixl 3

Optionality operator for schemas.

(<+>) :: Schema -> Schema -> Schema infixl 4

Tupling.

merge :: Schema -> Schema -> Schema

If passed two objects, merges the fields. Otherwise creates a tuple.

field :: Text -> Bool -> Schema -> Schema

Create an object with a single field.

value :: Schema

An unbounded string.

number :: Schema

An unbounded number.

array :: Schema -> Schema

An unbounded array with non-unique values.

addField :: Text -> Bool -> Schema -> SchemaC

Add a field to an object, or tuple if passed a non-object.

addFields :: [(Text, Bool, Schema)] -> SchemaC

Add multiple fields to an object, or tuple if passed a non-object.

empty :: Schema

An empty object.

enum :: [Value] -> Schema

A choice between constant values.

unbounded :: Bound

unboundedLength :: LengthBound

nullable :: Schema -> Schema

The provided schema or null.