Data.JSON.Schema.Types

Types for defining JSON schemas.

Documentation

type Schema = Value

A schema is any JSON value.

data Value

A schema for a JSON value.

Constructors

Choice [Value]

A choice of multiple values, e.g. for sum types.

Object [Field]

A JSON object.

Map Value

A JSON object with arbitrary keys.

Array Int Int Bool Value

An array. The integers represent the lower and upper bound of the array size. The value -1 indicates no bound. The boolean denotes whether items have to unique.

Tuple [Value]

A fixed-length tuple of different values.

Value Int Int

A string. The integers denote the lower and upper bound of the length of the string. The value -1 indicates no bound.

Boolean

Number Int Int

A number. The integers denote the lower and upper bound on the value. The value -1 indicates no bound.

Null

Any

Instances

Eq Value

Show Value

data Field

A field in an object.

Constructors

Field

Fields

key :: String

required :: Bool

content :: Schema

Instances

Eq Field

Show Field

class JSONSchema a where

Class representing JSON schemas

Methods

schema :: Proxy a -> Schema

Instances

JSONSchema Bool

JSONSchema Int

JSONSchema Integer

JSONSchema Word32

JSONSchema ()

JSONSchema Text

JSONSchema a => JSONSchema [a]

JSONSchema a => JSONSchema (Maybe a)

JSONSchema a => JSONSchema (Vector a)

(IsString k, JSONSchema v) => JSONSchema (HashMap k v)

(IsString k, JSONSchema v) => JSONSchema (Map k v)