json-schema-0.7.4.2: Types and type classes for defining JSON schemas.

Safe Haskell	None
Language	Haskell2010

Data.JSON.Schema.Combinators

Description

Combinators for creating JSON schemas.

Synopsis

type SchemaC = Schema -> Schema
(<|>) :: Schema -> Schema -> Schema
(<+>) :: Schema -> Schema -> Schema
merge :: Schema -> Schema -> Schema
field :: Text -> Bool -> Schema -> Schema
value :: Schema
number :: Schema
array :: Schema -> Schema
addField :: Text -> Bool -> Schema -> SchemaC
addFields :: [(Text, Bool, Schema)] -> SchemaC
empty :: Schema
enum :: [Value] -> Schema
unbounded :: Bound
unboundedLength :: LengthBound
nullable :: Schema -> Schema

Documentation

type SchemaC = Schema -> Schema Source #

A schema combinator.

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

Optionality operator for schemas.

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

Tupling.

merge :: Schema -> Schema -> Schema Source #

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

field :: Text -> Bool -> Schema -> Schema Source #

Create an object with a single field.

value :: Schema Source #

An unbounded string.

number :: Schema Source #

An unbounded number.

array :: Schema -> Schema Source #

An unbounded array with non-unique values.

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

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

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

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

empty :: Schema Source #

An empty object.

enum :: [Value] -> Schema Source #

A choice between constant values.

unbounded :: Bound Source #

unboundedLength :: LengthBound Source #

nullable :: Schema -> Schema Source #

The provided schema or null.