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

Methods

(==) :: RegularExpression -> RegularExpression -> Bool

(/=) :: RegularExpression -> RegularExpression -> Bool

Ord RegularExpression

Methods

compare :: RegularExpression -> RegularExpression -> Ordering

(<) :: RegularExpression -> RegularExpression -> Bool

(<=) :: RegularExpression -> RegularExpression -> Bool

(>) :: RegularExpression -> RegularExpression -> Bool

(>=) :: RegularExpression -> RegularExpression -> Bool

max :: RegularExpression -> RegularExpression -> RegularExpression

min :: RegularExpression -> RegularExpression -> RegularExpression

Show RegularExpression

Methods

showsPrec :: Int -> RegularExpression -> ShowS

show :: RegularExpression -> String

showList :: [RegularExpression] -> ShowS

IsString RegularExpression

Methods

fromString :: String -> RegularExpression

Arbitrary RegularExpression

Methods

arbitrary :: Gen RegularExpression

shrink :: RegularExpression -> [RegularExpression]

ToJSON RegularExpression

Methods

toJSON :: RegularExpression -> Value

toEncoding :: RegularExpression -> Encoding

toJSONList :: [RegularExpression] -> Value

toEncodingList :: [RegularExpression] -> Encoding

FromJSON RegularExpression

Methods

parseJSON :: Value -> Parser RegularExpression

parseJSONList :: Value -> Parser [RegularExpression]

NFData RegularExpression

Methods

rnf :: RegularExpression -> ()

SafeCopy RegularExpression

Methods

version :: Version RegularExpression

kind :: Kind RegularExpression

getCopy :: Contained (Get RegularExpression)

putCopy :: RegularExpression -> Contained Put

internalConsistency :: Consistency RegularExpression

objectProfile :: Profile RegularExpression

errorTypeName :: Proxy RegularExpression -> String

Serialise RegularExpression

Methods

encode :: RegularExpression -> Encoding

decode :: Decoder s RegularExpression

encodeList :: [RegularExpression] -> Encoding

decodeList :: Decoder s [RegularExpression]

Example RegularExpression

Methods

example :: Gen RegularExpression

FromJSONWithErrs RegularExpression

Methods

parseJSONWithErrs :: Value -> ParserWithErrs RegularExpression

data IntRange

Constructors

IntRange

Fields

• _ir_lo :: !(Maybe Int)
• _ir_hi :: !(Maybe Int)

Instances

Eq IntRange

Methods

(==) :: IntRange -> IntRange -> Bool

(/=) :: IntRange -> IntRange -> Bool

Show IntRange

Methods

showsPrec :: Int -> IntRange -> ShowS

show :: IntRange -> String

showList :: [IntRange] -> ShowS

Arbitrary IntRange

Methods

arbitrary :: Gen IntRange

shrink :: IntRange -> [IntRange]

ToJSON IntRange

Methods

toJSON :: IntRange -> Value

toEncoding :: IntRange -> Encoding

toJSONList :: [IntRange] -> Value

toEncodingList :: [IntRange] -> Encoding

FromJSON IntRange

Methods

parseJSON :: Value -> Parser IntRange

parseJSONList :: Value -> Parser [IntRange]

NFData IntRange

Methods

rnf :: IntRange -> ()

SafeCopy IntRange

Methods

version :: Version IntRange

kind :: Kind IntRange

getCopy :: Contained (Get IntRange)

putCopy :: IntRange -> Contained Put

internalConsistency :: Consistency IntRange

objectProfile :: Profile IntRange

errorTypeName :: Proxy IntRange -> String

Serialise IntRange

Methods

encode :: IntRange -> Encoding

decode :: Decoder s IntRange

encodeList :: [IntRange] -> Encoding

decodeList :: Decoder s [IntRange]

Example IntRange

Methods

example :: Gen IntRange

FromJSONWithErrs IntRange

Methods

parseJSONWithErrs :: Value -> ParserWithErrs IntRange

data UTCRange

Constructors

UTCRange

Fields

• _ur_lo :: !(Maybe UTCTime)
• _ur_hi :: !(Maybe UTCTime)

Instances

Eq UTCRange

Methods

(==) :: UTCRange -> UTCRange -> Bool

(/=) :: UTCRange -> UTCRange -> Bool

Show UTCRange

Methods

showsPrec :: Int -> UTCRange -> ShowS

show :: UTCRange -> String

showList :: [UTCRange] -> ShowS

Arbitrary UTCRange

Methods

arbitrary :: Gen UTCRange

shrink :: UTCRange -> [UTCRange]

ToJSON UTCRange

Methods

toJSON :: UTCRange -> Value

toEncoding :: UTCRange -> Encoding

toJSONList :: [UTCRange] -> Value

toEncodingList :: [UTCRange] -> Encoding

FromJSON UTCRange

Methods

parseJSON :: Value -> Parser UTCRange

parseJSONList :: Value -> Parser [UTCRange]

NFData UTCRange

Methods

rnf :: UTCRange -> ()

SafeCopy UTCRange

Methods

version :: Version UTCRange

kind :: Kind UTCRange

getCopy :: Contained (Get UTCRange)

putCopy :: UTCRange -> Contained Put

internalConsistency :: Consistency UTCRange

objectProfile :: Profile UTCRange

errorTypeName :: Proxy UTCRange -> String

Serialise UTCRange

Methods

encode :: UTCRange -> Encoding

decode :: Decoder s UTCRange

encodeList :: [UTCRange] -> Encoding

decodeList :: Decoder s [UTCRange]

Example UTCRange

Methods

example :: Gen UTCRange

FromJSONWithErrs UTCRange

Methods

parseJSONWithErrs :: Value -> ParserWithErrs UTCRange

data Filter

Constructors

FT_string !RegularExpression

FT_integer !IntRange

FT_utc !UTCRange

Instances

Eq Filter

Methods

(==) :: Filter -> Filter -> Bool

(/=) :: Filter -> Filter -> Bool

Show Filter

Methods

showsPrec :: Int -> Filter -> ShowS

show :: Filter -> String

showList :: [Filter] -> ShowS

Arbitrary Filter

Methods

arbitrary :: Gen Filter

shrink :: Filter -> [Filter]

ToJSON Filter

Methods

toJSON :: Filter -> Value

toEncoding :: Filter -> Encoding

toJSONList :: [Filter] -> Value

toEncodingList :: [Filter] -> Encoding

FromJSON Filter

Methods

parseJSON :: Value -> Parser Filter

parseJSONList :: Value -> Parser [Filter]

NFData Filter

Methods

rnf :: Filter -> ()

SafeCopy Filter

Methods

version :: Version Filter

kind :: Kind Filter

getCopy :: Contained (Get Filter)

putCopy :: Filter -> Contained Put

internalConsistency :: Consistency Filter

objectProfile :: Profile Filter

errorTypeName :: Proxy Filter -> String

Serialise Filter

Methods

encode :: Filter -> Encoding

decode :: Decoder s Filter

encodeList :: [Filter] -> Encoding

decodeList :: Decoder s [Filter]

Example Filter

Methods

example :: Gen Filter

FromJSONWithErrs Filter

Methods

parseJSONWithErrs :: Value -> ParserWithErrs Filter

data Conversion

Constructors

Conversion

Fields

• _cv_injection :: !Text
• _cv_projection :: !Text

Instances

Eq Conversion

Methods

(==) :: Conversion -> Conversion -> Bool

(/=) :: Conversion -> Conversion -> Bool

Show Conversion

Methods

showsPrec :: Int -> Conversion -> ShowS

show :: Conversion -> String

showList :: [Conversion] -> ShowS

Arbitrary Conversion

Methods

arbitrary :: Gen Conversion

shrink :: Conversion -> [Conversion]

ToJSON Conversion

Methods

toJSON :: Conversion -> Value

toEncoding :: Conversion -> Encoding

toJSONList :: [Conversion] -> Value

toEncodingList :: [Conversion] -> Encoding

FromJSON Conversion

Methods

parseJSON :: Value -> Parser Conversion

parseJSONList :: Value -> Parser [Conversion]

NFData Conversion

Methods

rnf :: Conversion -> ()

SafeCopy Conversion

Methods

version :: Version Conversion

kind :: Kind Conversion

getCopy :: Contained (Get Conversion)

putCopy :: Conversion -> Contained Put

internalConsistency :: Consistency Conversion

objectProfile :: Profile Conversion

errorTypeName :: Proxy Conversion -> String

Serialise Conversion

Methods

encode :: Conversion -> Encoding

decode :: Decoder s Conversion

encodeList :: [Conversion] -> Encoding

decodeList :: Decoder s [Conversion]

Example Conversion

Methods

example :: Gen Conversion

FromJSONWithErrs Conversion

Methods

parseJSONWithErrs :: Value -> ParserWithErrs Conversion

newtype TypeRef

Constructors

TypeRef

Fields

• _TypeRef :: Text

Instances

Eq TypeRef

Methods

(==) :: TypeRef -> TypeRef -> Bool

(/=) :: TypeRef -> TypeRef -> Bool

Ord TypeRef

Methods

compare :: TypeRef -> TypeRef -> Ordering

(<) :: TypeRef -> TypeRef -> Bool

(<=) :: TypeRef -> TypeRef -> Bool

(>) :: TypeRef -> TypeRef -> Bool

(>=) :: TypeRef -> TypeRef -> Bool

max :: TypeRef -> TypeRef -> TypeRef

min :: TypeRef -> TypeRef -> TypeRef

Show TypeRef

Methods

showsPrec :: Int -> TypeRef -> ShowS

show :: TypeRef -> String

showList :: [TypeRef] -> ShowS

IsString TypeRef

Methods

fromString :: String -> TypeRef

Arbitrary TypeRef

Methods

arbitrary :: Gen TypeRef

shrink :: TypeRef -> [TypeRef]

ToJSON TypeRef

Methods

toJSON :: TypeRef -> Value

toEncoding :: TypeRef -> Encoding

toJSONList :: [TypeRef] -> Value

toEncodingList :: [TypeRef] -> Encoding

FromJSON TypeRef

Methods

parseJSON :: Value -> Parser TypeRef

parseJSONList :: Value -> Parser [TypeRef]

NFData TypeRef

Methods

rnf :: TypeRef -> ()

SafeCopy TypeRef

Methods

version :: Version TypeRef

kind :: Kind TypeRef

getCopy :: Contained (Get TypeRef)

putCopy :: TypeRef -> Contained Put

internalConsistency :: Consistency TypeRef

objectProfile :: Profile TypeRef

errorTypeName :: Proxy TypeRef -> String

Serialise TypeRef

Methods

encode :: TypeRef -> Encoding

decode :: Decoder s TypeRef

encodeList :: [TypeRef] -> Encoding

decodeList :: Decoder s [TypeRef]

Example TypeRef

Methods

example :: Gen TypeRef

FromJSONWithErrs TypeRef

Methods

parseJSONWithErrs :: Value -> ParserWithErrs TypeRef

data BasicType

Constructors

BT_string

BT_binary

BT_boolean

BT_integer

BT_utc

Instances

Bounded BasicType

Methods

minBound :: BasicType

maxBound :: BasicType

Enum BasicType

Methods

succ :: BasicType -> BasicType

pred :: BasicType -> BasicType

toEnum :: Int -> BasicType

fromEnum :: BasicType -> Int

enumFrom :: BasicType -> [BasicType]

enumFromThen :: BasicType -> BasicType -> [BasicType]

enumFromTo :: BasicType -> BasicType -> [BasicType]

enumFromThenTo :: BasicType -> BasicType -> BasicType -> [BasicType]

Eq BasicType

Methods

(==) :: BasicType -> BasicType -> Bool

(/=) :: BasicType -> BasicType -> Bool

Ord BasicType

Methods

compare :: BasicType -> BasicType -> Ordering

(<) :: BasicType -> BasicType -> Bool

(<=) :: BasicType -> BasicType -> Bool

(>) :: BasicType -> BasicType -> Bool

(>=) :: BasicType -> BasicType -> Bool

max :: BasicType -> BasicType -> BasicType

min :: BasicType -> BasicType -> BasicType

Show BasicType

Methods

showsPrec :: Int -> BasicType -> ShowS

show :: BasicType -> String

showList :: [BasicType] -> ShowS

Arbitrary BasicType

Methods

arbitrary :: Gen BasicType

shrink :: BasicType -> [BasicType]

ToJSON BasicType

Methods

toJSON :: BasicType -> Value

toEncoding :: BasicType -> Encoding

toJSONList :: [BasicType] -> Value

toEncodingList :: [BasicType] -> Encoding

FromJSON BasicType

Methods

parseJSON :: Value -> Parser BasicType

parseJSONList :: Value -> Parser [BasicType]

NFData BasicType

Methods

rnf :: BasicType -> ()

SafeCopy BasicType

Methods

version :: Version BasicType

kind :: Kind BasicType

getCopy :: Contained (Get BasicType)

putCopy :: BasicType -> Contained Put

internalConsistency :: Consistency BasicType

objectProfile :: Profile BasicType

errorTypeName :: Proxy BasicType -> String

Serialise BasicType

Methods

encode :: BasicType -> Encoding

decode :: Decoder s BasicType

encodeList :: [BasicType] -> Encoding

decodeList :: Decoder s [BasicType]

Example BasicType

Methods

example :: Gen BasicType

FromJSONWithErrs BasicType

Methods

parseJSONWithErrs :: Value -> ParserWithErrs BasicType

data APIType

Constructors

TY_list !APIType

TY_maybe !APIType

TY_ref !TypeRef

TY_basic !BasicType

TY_json !Int

Instances

Eq APIType

Methods

(==) :: APIType -> APIType -> Bool

(/=) :: APIType -> APIType -> Bool

Show APIType

Methods

showsPrec :: Int -> APIType -> ShowS

show :: APIType -> String

showList :: [APIType] -> ShowS

Arbitrary APIType

Methods

arbitrary :: Gen APIType

shrink :: APIType -> [APIType]

ToJSON APIType

Methods

toJSON :: APIType -> Value

toEncoding :: APIType -> Encoding

toJSONList :: [APIType] -> Value

toEncodingList :: [APIType] -> Encoding

FromJSON APIType

Methods

parseJSON :: Value -> Parser APIType

parseJSONList :: Value -> Parser [APIType]

NFData APIType

Methods

rnf :: APIType -> ()

SafeCopy APIType

Methods

version :: Version APIType

kind :: Kind APIType

getCopy :: Contained (Get APIType)

putCopy :: APIType -> Contained Put

internalConsistency :: Consistency APIType

objectProfile :: Profile APIType

errorTypeName :: Proxy APIType -> String

Serialise APIType

Methods

encode :: APIType -> Encoding

decode :: Decoder s APIType

encodeList :: [APIType] -> Encoding

decodeList :: Decoder s [APIType]

Example APIType

Methods

example :: Gen APIType

FromJSONWithErrs APIType

Methods

parseJSONWithErrs :: Value -> ParserWithErrs APIType

data SpecNewtype

Constructors

SpecNewtype

Fields

• _sn_type :: !BasicType
• _sn_filter :: !(Maybe Filter)

Instances

Eq SpecNewtype

Methods

(==) :: SpecNewtype -> SpecNewtype -> Bool

(/=) :: SpecNewtype -> SpecNewtype -> Bool

Show SpecNewtype

Methods

showsPrec :: Int -> SpecNewtype -> ShowS

show :: SpecNewtype -> String

showList :: [SpecNewtype] -> ShowS

Arbitrary SpecNewtype

Methods

arbitrary :: Gen SpecNewtype

shrink :: SpecNewtype -> [SpecNewtype]

ToJSON SpecNewtype

Methods

toJSON :: SpecNewtype -> Value

toEncoding :: SpecNewtype -> Encoding

toJSONList :: [SpecNewtype] -> Value

toEncodingList :: [SpecNewtype] -> Encoding

FromJSON SpecNewtype

Methods

parseJSON :: Value -> Parser SpecNewtype

parseJSONList :: Value -> Parser [SpecNewtype]

NFData SpecNewtype

Methods

rnf :: SpecNewtype -> ()

SafeCopy SpecNewtype

Methods

version :: Version SpecNewtype

kind :: Kind SpecNewtype

getCopy :: Contained (Get SpecNewtype)

putCopy :: SpecNewtype -> Contained Put

internalConsistency :: Consistency SpecNewtype

objectProfile :: Profile SpecNewtype

errorTypeName :: Proxy SpecNewtype -> String

Serialise SpecNewtype

Methods

encode :: SpecNewtype -> Encoding

decode :: Decoder s SpecNewtype

encodeList :: [SpecNewtype] -> Encoding

decodeList :: Decoder s [SpecNewtype]

Example SpecNewtype

Methods

example :: Gen SpecNewtype

FromJSONWithErrs SpecNewtype

Methods

parseJSONWithErrs :: Value -> ParserWithErrs 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

Methods

(==) :: DefaultValue -> DefaultValue -> Bool

(/=) :: DefaultValue -> DefaultValue -> Bool

Show DefaultValue

Methods

showsPrec :: Int -> DefaultValue -> ShowS

show :: DefaultValue -> String

showList :: [DefaultValue] -> ShowS

Arbitrary DefaultValue

Methods

arbitrary :: Gen DefaultValue

shrink :: DefaultValue -> [DefaultValue]

ToJSON DefaultValue

Methods

toJSON :: DefaultValue -> Value

toEncoding :: DefaultValue -> Encoding

toJSONList :: [DefaultValue] -> Value

toEncodingList :: [DefaultValue] -> Encoding

FromJSON DefaultValue

Methods

parseJSON :: Value -> Parser DefaultValue

parseJSONList :: Value -> Parser [DefaultValue]

NFData DefaultValue

Methods

rnf :: DefaultValue -> ()

SafeCopy DefaultValue

Methods

version :: Version DefaultValue

kind :: Kind DefaultValue

getCopy :: Contained (Get DefaultValue)

putCopy :: DefaultValue -> Contained Put

internalConsistency :: Consistency DefaultValue

objectProfile :: Profile DefaultValue

errorTypeName :: Proxy DefaultValue -> String

Serialise DefaultValue

Methods

encode :: DefaultValue -> Encoding

decode :: Decoder s DefaultValue

encodeList :: [DefaultValue] -> Encoding

decodeList :: Decoder s [DefaultValue]

Example DefaultValue

Methods

example :: Gen DefaultValue

FromJSONWithErrs DefaultValue

Methods

parseJSONWithErrs :: Value -> ParserWithErrs 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

Methods

(==) :: Field -> Field -> Bool

(/=) :: Field -> Field -> Bool

Show Field

Methods

showsPrec :: Int -> Field -> ShowS

show :: Field -> String

showList :: [Field] -> ShowS

Arbitrary Field

Methods

arbitrary :: Gen Field

shrink :: Field -> [Field]

ToJSON Field

Methods

toJSON :: Field -> Value

toEncoding :: Field -> Encoding

toJSONList :: [Field] -> Value

toEncodingList :: [Field] -> Encoding

FromJSON Field

Methods

parseJSON :: Value -> Parser Field

parseJSONList :: Value -> Parser [Field]

NFData Field

Methods

rnf :: Field -> ()

SafeCopy Field

Methods

version :: Version Field

kind :: Kind Field

getCopy :: Contained (Get Field)

putCopy :: Field -> Contained Put

internalConsistency :: Consistency Field

objectProfile :: Profile Field

errorTypeName :: Proxy Field -> String

Serialise Field

Methods

encode :: Field -> Encoding

decode :: Decoder s Field

encodeList :: [Field] -> Encoding

decodeList :: Decoder s [Field]

Example Field

Methods

example :: Gen Field

FromJSONWithErrs Field

Methods

parseJSONWithErrs :: Value -> ParserWithErrs Field

data Spec

Constructors

SP_newtype !SpecNewtype

SP_record ![Field]

SP_union ![Field]

SP_enum ![Text]

SP_synonym !APIType

Instances

Eq Spec

Methods

(==) :: Spec -> Spec -> Bool

(/=) :: Spec -> Spec -> Bool

Show Spec

Methods

showsPrec :: Int -> Spec -> ShowS

show :: Spec -> String

showList :: [Spec] -> ShowS

Arbitrary Spec

Methods

arbitrary :: Gen Spec

shrink :: Spec -> [Spec]

ToJSON Spec

Methods

toJSON :: Spec -> Value

toEncoding :: Spec -> Encoding

toJSONList :: [Spec] -> Value

toEncodingList :: [Spec] -> Encoding

FromJSON Spec

Methods

parseJSON :: Value -> Parser Spec

parseJSONList :: Value -> Parser [Spec]

NFData Spec

Methods

rnf :: Spec -> ()

SafeCopy Spec

Methods

version :: Version Spec

kind :: Kind Spec

getCopy :: Contained (Get Spec)

putCopy :: Spec -> Contained Put

internalConsistency :: Consistency Spec

objectProfile :: Profile Spec

errorTypeName :: Proxy Spec -> String

Serialise Spec

Methods

encode :: Spec -> Encoding

decode :: Decoder s Spec

encodeList :: [Spec] -> Encoding

decodeList :: Decoder s [Spec]

Example Spec

Methods

example :: Gen Spec

FromJSONWithErrs Spec

Methods

parseJSONWithErrs :: Value -> ParserWithErrs 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

Methods

(==) :: APINode -> APINode -> Bool

(/=) :: APINode -> APINode -> Bool

Show APINode

Methods

showsPrec :: Int -> APINode -> ShowS

show :: APINode -> String

showList :: [APINode] -> ShowS

Arbitrary APINode

Methods

arbitrary :: Gen APINode

shrink :: APINode -> [APINode]

ToJSON APINode

Methods

toJSON :: APINode -> Value

toEncoding :: APINode -> Encoding

toJSONList :: [APINode] -> Value

toEncodingList :: [APINode] -> Encoding

FromJSON APINode

Methods

parseJSON :: Value -> Parser APINode

parseJSONList :: Value -> Parser [APINode]

NFData APINode

Methods

rnf :: APINode -> ()

SafeCopy APINode

Methods

version :: Version APINode

kind :: Kind APINode

getCopy :: Contained (Get APINode)

putCopy :: APINode -> Contained Put

internalConsistency :: Consistency APINode

objectProfile :: Profile APINode

errorTypeName :: Proxy APINode -> String

Serialise APINode

Methods

encode :: APINode -> Encoding

decode :: Decoder s APINode

encodeList :: [APINode] -> Encoding

decodeList :: Decoder s [APINode]

Example APINode

Methods

example :: Gen APINode

FromJSONWithErrs APINode

Methods

parseJSONWithErrs :: Value -> ParserWithErrs APINode

type APISpec = [APINode]

apiAPITestsJSONToCBOR :: [(String, Property)]

apiAPITestsCBORToJSON :: [(String, Property)]

apiAPITestsCBOR :: [(String, Property)]

apiAPITestsJSON :: [(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