Data.JSON.Schema.Generator.Class

Documentation

class JSONSchemaGen a where

Minimal complete definition

Nothing

Methods

toSchema :: Options -> Proxy a -> Schema

class JSONSchemaPrim a where

Methods

toSchemaPrim :: Options -> Proxy a -> Schema

Instances

JSONSchemaPrim Bool

JSONSchemaPrim Double

JSONSchemaPrim Float

JSONSchemaPrim Int

JSONSchemaPrim Integer

JSONSchemaPrim String

(Typeable * a, JSONSchemaGen a) => JSONSchemaPrim a

JSONSchemaPrim UTCTime

JSONSchemaPrim Text

JSONSchemaPrim a => JSONSchemaPrim [a]

JSONSchemaPrim a => JSONSchemaPrim (Map String a)

JSONSchemaPrim a => JSONSchemaPrim (HashMap String a)

class GJSONSchemaGen f where

Methods

gToSchema :: Options -> Proxy (f a) -> Schema

Instances

(Datatype d, SchemaType f) => GJSONSchemaGen (D1 d f)

genericToSchema :: (Generic a, GJSONSchemaGen (Rep a)) => Options -> Proxy a -> Schema

data Options

Options that specify how to generate schema definition automatically from your datatype.

Constructors

Options

Fields

baseUri :: String

schema id prefix.

schemaIdSuffix :: String

schema id suffix. File extension for example.

typeRefMap :: Map TypeRep String

a mapping from datatypes to referenced schema ids.

fieldTypeMap :: Map String FieldType

a mapping to assign a preffered type to a field.

Instances

Show Options

data FieldType

Constructors

forall a . JSONSchemaPrim a => FieldType (Proxy a)

defaultOptions :: Options

Default geerating Options:

Options
{ baseUri        = ""
, schemaIdSuffix = ""
, refSchemaMap   = Map.empty
}