Safe Haskell	None
Language	Haskell2010

Data.API.Types

Synopsis

Documentation

type API = [Thing] Source

an API spec is made up of a list of type/element specs, each specifying a Haskell type and JSON wrappers

data Thing Source

Constructors

ThComment MDComment
ThNode APINode

Instances

Show Thing
ToJSON Thing
FromJSON Thing
FromJSONWithErrs Thing	Generate an API spec from the JSON

data APINode Source

Specifies an individual element/type of the API

Constructors

APINode
Fields anName :: TypeName name of Haskell type anComment :: MDComment comment describing type in Markdown anPrefix :: Prefix distinct short prefix (see below) anSpec :: Spec the type specification anConvert :: Conversion optional conversion functions

Instances

Show APINode
ToJSON APINode
FromJSON APINode

newtype TypeName Source

TypeName must contain a valid Haskell type constructor

Constructors

TypeName
Fields _TypeName :: String

Instances

Eq TypeName
Ord TypeName
Show TypeName
IsString TypeName
ToJSON TypeName
FromJSON TypeName
PP TypeName

newtype FieldName Source

FieldName identifies recod fields and union alternatives must contain a valid identifier valid in Haskell and any API client wrappers (e.g., if Ruby wrappers are to be generated the names should easily map into Ruby)

Constructors

FieldName
Fields _FieldName :: String

Instances

Eq FieldName
Ord FieldName
Show FieldName
IsString FieldName
ToJSON FieldName
FromJSON FieldName
PP FieldName

type MDComment = String Source

Markdown comments are represented by strings

type Prefix = CI String Source

a distinct case-insensitive short prefix used to form unique record field names and data constructors:

must be a valid Haskell identifier
- must be unique within the API

data Spec Source

type/element specs are either simple type isomorphisms of basic JSON types, records, unions or enumerated types

Constructors

SpNewtype SpecNewtype
SpRecord SpecRecord
SpUnion SpecUnion
SpEnum SpecEnum
SpSynonym APIType

Instances

Show Spec
ToJSON Spec
FromJSON Spec

data SpecNewtype Source

SpecNewtype elements are isomorphisms of string, inetgers or booleans

Constructors

SpecNewtype
Fields snType :: BasicType snFilter :: Maybe Filter

Instances

Show SpecNewtype
ToJSON SpecNewtype
FromJSON SpecNewtype

data SpecRecord Source

SpecRecord is your classsic product type.

Constructors

SpecRecord
Fields srFields :: [(FieldName, FieldType)]

Instances

Show SpecRecord
ToJSON SpecRecord
FromJSON SpecRecord

data FieldType Source

In addition to the type and comment, record fields may carry a flag indicating that they are read-only, and may have a default value, which must be of a compatible type.

Constructors

FieldType
Fields ftType :: APIType ftReadOnly :: Bool ftDefault :: Maybe DefaultValue ftComment :: MDComment

Instances

Show FieldType
ToJSON FieldType
FromJSON FieldType

data SpecUnion Source

SpecUnion is your classsic union type

Constructors

SpecUnion
Fields suFields :: [(FieldName, (APIType, MDComment))]

Instances

Show SpecUnion
ToJSON SpecUnion
FromJSON SpecUnion

data SpecEnum Source

SpecEnum is your classic enumerated type

Constructors

SpecEnum
Fields seAlts :: [(FieldName, MDComment)]

Instances

Show SpecEnum
ToJSON SpecEnum
FromJSON SpecEnum

type Conversion = Maybe (FieldName, FieldName) Source

data APIType Source

Type is either a list, Maybe, a named element of the API or a basic type

Constructors

TyList APIType	list elements are types
TyMaybe APIType	Maybe elements are types
TyName TypeName	the referenced type must be defined by the API
TyBasic BasicType	a JSON string, int, bool etc.
TyJSON	a generic JSON value

Instances

Eq APIType
Show APIType
IsString APIType	It is sometimes helpful to write a type name directly as a string
ToJSON APIType
FromJSON APIType
PP APIType

data DefaultValue Source

A default value for a field

Constructors

DefValList
DefValMaybe
DefValString Text
DefValBool Bool
DefValInt Int
DefValUtc UTCTime

Instances

Eq DefaultValue
Show DefaultValue
ToJSON DefaultValue
FromJSON DefaultValue
Lift DefaultValue
PP DefaultValue

data BasicType Source

the basic JSON types (N.B., no floating point numbers, yet)

Constructors

BTstring	a JSON UTF-8 string
BTbinary	a base-64-encoded byte string
BTbool	a JSON bool
BTint	a JSON integral number
BTutc	a JSON UTC string

Instances

Eq BasicType
Show BasicType
ToJSON BasicType
FromJSON BasicType
PP BasicType

data Filter Source

Constructors

FtrStrg RegEx
FtrIntg IntRange
FtrUTC UTCRange

Instances

Show Filter
ToJSON Filter
FromJSON Filter

data IntRange Source

Constructors

IntRange
Fields ir_lo :: Maybe Int ir_hi :: Maybe Int

Instances

Eq IntRange
Show IntRange
ToJSON IntRange
FromJSON IntRange
Lift IntRange

data UTCRange Source

Constructors

UTCRange
Fields ur_lo :: Maybe UTCTime ur_hi :: Maybe UTCTime

Instances

Eq UTCRange
Show UTCRange
ToJSON UTCRange
FromJSON UTCRange
Lift UTCRange

data RegEx Source

Constructors

RegEx
Fields re_text :: Text re_regex :: Regex

Instances

Eq RegEx
Show RegEx
ToJSON RegEx
FromJSON RegEx
Lift RegEx

newtype Binary Source

Binary data is represented in JSON format as a base64-encoded string

Constructors

Binary
Fields _Binary :: ByteString

Instances

Eq Binary
Ord Binary
Show Binary
Arbitrary Binary
ToJSON Binary
FromJSON Binary
SafeCopy Binary
FromJSONWithErrs Binary
Example Binary

defaultValueAsJsValue :: DefaultValue -> Value Source

Convert a default value to an Aeson Value. This differs from toJSON as it will not round-trip with fromJSON: UTC default values are turned into strings.

mkRegEx :: Text -> RegEx Source

inIntRange :: Int -> IntRange -> Bool Source

inUTCRange :: UTCTime -> UTCRange -> Bool Source