Data.JSON.Schema.Generator.Class

Documentation

class JSONSchemaGen a where

Methods

toSchema :: Options -> Proxy a -> Schema

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

class JSONSchemaPrim a where

Minimal complete definition

toSchemaPrim

Methods

toSchemaPrim :: Options -> Proxy a -> Schema

class GJSONSchemaGen f where

Minimal complete definition

gToSchema

Methods

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

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

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

data FieldType

Constructors

JSONSchemaPrim a => FieldType (Proxy a)

defaultOptions :: Options

Default geerating Options:

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