Data.API.API.Gen

This module contains datatypes generated from the DSL description of the api-tools API; they thus correspond to the types in Data.API.Types.

Documentation

newtype RegularExpression

Constructors

RegularExpression

Fields

_RegularExpression :: Text

Instances

Eq RegularExpression

Ord RegularExpression

Show RegularExpression

Typeable RegularExpression

IsString RegularExpression

Arbitrary RegularExpression

ToJSON RegularExpression

SafeCopy RegularExpression

FromJSONWithErrs RegularExpression

Example RegularExpression

data IntRange

Constructors

IntRange

Fields

_ir_lo :: !(Maybe Int)

_ir_hi :: !(Maybe Int)

Instances

Eq IntRange

Show IntRange

Typeable IntRange

Arbitrary IntRange

ToJSON IntRange

SafeCopy IntRange

FromJSONWithErrs IntRange

Example IntRange

data UTCRange

Constructors

UTCRange

Fields

_ur_lo :: !(Maybe UTCTime)

_ur_hi :: !(Maybe UTCTime)

Instances

Eq UTCRange

Show UTCRange

Typeable UTCRange

Arbitrary UTCRange

ToJSON UTCRange

SafeCopy UTCRange

FromJSONWithErrs UTCRange

Example UTCRange

data Filter

Constructors

FT_string !RegularExpression

FT_integer !IntRange

FT_utc !UTCRange

Instances

Eq Filter

Show Filter

Typeable Filter

Arbitrary Filter

ToJSON Filter

SafeCopy Filter

FromJSONWithErrs Filter

Example Filter

data Conversion

Constructors

Conversion

Fields

_cv_injection :: !Text

_cv_projection :: !Text

Instances

Eq Conversion

Show Conversion

Typeable Conversion

Arbitrary Conversion

ToJSON Conversion

SafeCopy Conversion

FromJSONWithErrs Conversion

Example Conversion

newtype TypeRef

Constructors

TypeRef

Fields

_TypeRef :: Text

Instances

Eq TypeRef

Ord TypeRef

Show TypeRef

Typeable TypeRef

IsString TypeRef

Arbitrary TypeRef

ToJSON TypeRef

SafeCopy TypeRef

FromJSONWithErrs TypeRef

Example TypeRef

data BasicType

Constructors

BT_string

BT_binary

BT_boolean

BT_integer

BT_utc

Instances

Bounded BasicType

Enum BasicType

Eq BasicType

Ord BasicType

Show BasicType

Typeable BasicType

Arbitrary BasicType

ToJSON BasicType

SafeCopy BasicType

FromJSONWithErrs BasicType

Example BasicType

data APIType

Constructors

TY_list !APIType

TY_maybe !APIType

TY_ref !TypeRef

TY_basic !BasicType

TY_json !Int

Instances

Eq APIType

Show APIType

Typeable APIType

Arbitrary APIType

ToJSON APIType

SafeCopy APIType

FromJSONWithErrs APIType

Example APIType

data SpecNewtype

Constructors

SpecNewtype

Fields

_sn_type :: !BasicType

_sn_filter :: !(Maybe Filter)

Instances

Eq SpecNewtype

Show SpecNewtype

Typeable SpecNewtype

Arbitrary SpecNewtype

ToJSON SpecNewtype

SafeCopy SpecNewtype

FromJSONWithErrs SpecNewtype

Example SpecNewtype

data DefaultValue

Constructors

DV_list !Int

DV_maybe !Int

DV_string !Text

DV_boolean !Bool

DV_integer !Int

DV_utc !UTCTime

Instances

Eq DefaultValue

Show DefaultValue

Typeable DefaultValue

Arbitrary DefaultValue

ToJSON DefaultValue

SafeCopy DefaultValue

FromJSONWithErrs DefaultValue

Example DefaultValue

data Field

Constructors

Field

Fields

_fd_name :: !Text

_fd_type :: !APIType

_fd_readonly :: !Bool

_fd_default :: !(Maybe DefaultValue)

_fd_comment :: !Text

Instances

Eq Field

Show Field

Typeable Field

Arbitrary Field

ToJSON Field

SafeCopy Field

FromJSONWithErrs Field

Example Field

data Spec

Constructors

SP_newtype !SpecNewtype

SP_record ![Field]

SP_union ![Field]

SP_enum ![Text]

SP_synonym !APIType

Instances

Eq Spec

Show Spec

Typeable Spec

Arbitrary Spec

ToJSON Spec

SafeCopy Spec

FromJSONWithErrs Spec

Example Spec

data APINode

Constructors

APINode

Fields

_an_name :: !Text

_an_comment :: !Text

_an_prefix :: !Text

_an_spec :: !Spec

_an_convert :: !(Maybe Conversion)

Instances

Eq APINode

Show APINode

Typeable APINode

Arbitrary APINode

ToJSON APINode

SafeCopy APINode

FromJSONWithErrs APINode

Example APINode

type APISpec = [APINode]

apiAPISimpleTests :: [(String, Property)]

apiAPISamples :: [(String, Gen Value)]

typeRef :: Iso' TypeRef Text

fd_type :: Lens' Field APIType

fd_readonly :: Lens' Field Bool

fd_name :: Lens' Field Text

fd_default :: Lens' Field (Maybe DefaultValue)

fd_comment :: Lens' Field Text

cv_projection :: Lens' Conversion Text

cv_injection :: Lens' Conversion Text

ur_lo :: Lens' UTCRange (Maybe UTCTime)

ur_hi :: Lens' UTCRange (Maybe UTCTime)

ir_lo :: Lens' IntRange (Maybe Int)

ir_hi :: Lens' IntRange (Maybe Int)

regularExpression :: Iso' RegularExpression Text

sn_type :: Lens' SpecNewtype BasicType

sn_filter :: Lens' SpecNewtype (Maybe Filter)

an_spec :: Lens' APINode Spec

an_prefix :: Lens' APINode Text

an_name :: Lens' APINode Text

an_convert :: Lens' APINode (Maybe Conversion)

an_comment :: Lens' APINode Text

_map_BasicType :: Map Text BasicType

_text_BasicType :: BasicType -> Text