Safe Haskell	None
Language	Haskell2010

Data.API.API.Gen

Description

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 Source #

Constructors

RegularExpression
Fields _RegularExpression :: Text

Instances

Eq RegularExpression Source #
Methods (==) :: RegularExpression -> RegularExpression -> Bool # (/=) :: RegularExpression -> RegularExpression -> Bool #
Ord RegularExpression Source #
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 Source #
Methods showsPrec :: Int -> RegularExpression -> ShowS # show :: RegularExpression -> String # showList :: [RegularExpression] -> ShowS #
IsString RegularExpression Source #
Methods fromString :: String -> RegularExpression #
Arbitrary RegularExpression Source #
Methods arbitrary :: Gen RegularExpression # shrink :: RegularExpression -> [RegularExpression] #
ToJSON RegularExpression Source #
Methods toJSON :: RegularExpression -> Value # toEncoding :: RegularExpression -> Encoding # toJSONList :: [RegularExpression] -> Value # toEncodingList :: [RegularExpression] -> Encoding #
FromJSON RegularExpression Source #
Methods parseJSON :: Value -> Parser RegularExpression # parseJSONList :: Value -> Parser [RegularExpression] #
NFData RegularExpression Source #
Methods rnf :: RegularExpression -> () #
SafeCopy RegularExpression Source #
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 Source #
Methods encode :: RegularExpression -> Encoding # decode :: Decoder s RegularExpression # encodeList :: [RegularExpression] -> Encoding # decodeList :: Decoder s [RegularExpression] #
Example RegularExpression Source #
Methods example :: Gen RegularExpression Source #
FromJSONWithErrs RegularExpression Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs RegularExpression Source #

data IntRange Source #

Constructors

IntRange
Fields _ir_lo :: !(Maybe Int) _ir_hi :: !(Maybe Int)

Instances

Eq IntRange Source #
Methods (==) :: IntRange -> IntRange -> Bool # (/=) :: IntRange -> IntRange -> Bool #
Show IntRange Source #
Methods showsPrec :: Int -> IntRange -> ShowS # show :: IntRange -> String # showList :: [IntRange] -> ShowS #
Arbitrary IntRange Source #
Methods arbitrary :: Gen IntRange # shrink :: IntRange -> [IntRange] #
ToJSON IntRange Source #
Methods toJSON :: IntRange -> Value # toEncoding :: IntRange -> Encoding # toJSONList :: [IntRange] -> Value # toEncodingList :: [IntRange] -> Encoding #
FromJSON IntRange Source #
Methods parseJSON :: Value -> Parser IntRange # parseJSONList :: Value -> Parser [IntRange] #
NFData IntRange Source #
Methods rnf :: IntRange -> () #
SafeCopy IntRange Source #
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 Source #
Methods encode :: IntRange -> Encoding # decode :: Decoder s IntRange # encodeList :: [IntRange] -> Encoding # decodeList :: Decoder s [IntRange] #
Example IntRange Source #
Methods example :: Gen IntRange Source #
FromJSONWithErrs IntRange Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs IntRange Source #

data UTCRange Source #

Constructors

UTCRange
Fields _ur_lo :: !(Maybe UTCTime) _ur_hi :: !(Maybe UTCTime)

Instances

Eq UTCRange Source #
Methods (==) :: UTCRange -> UTCRange -> Bool # (/=) :: UTCRange -> UTCRange -> Bool #
Show UTCRange Source #
Methods showsPrec :: Int -> UTCRange -> ShowS # show :: UTCRange -> String # showList :: [UTCRange] -> ShowS #
Arbitrary UTCRange Source #
Methods arbitrary :: Gen UTCRange # shrink :: UTCRange -> [UTCRange] #
ToJSON UTCRange Source #
Methods toJSON :: UTCRange -> Value # toEncoding :: UTCRange -> Encoding # toJSONList :: [UTCRange] -> Value # toEncodingList :: [UTCRange] -> Encoding #
FromJSON UTCRange Source #
Methods parseJSON :: Value -> Parser UTCRange # parseJSONList :: Value -> Parser [UTCRange] #
NFData UTCRange Source #
Methods rnf :: UTCRange -> () #
SafeCopy UTCRange Source #
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 Source #
Methods encode :: UTCRange -> Encoding # decode :: Decoder s UTCRange # encodeList :: [UTCRange] -> Encoding # decodeList :: Decoder s [UTCRange] #
Example UTCRange Source #
Methods example :: Gen UTCRange Source #
FromJSONWithErrs UTCRange Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs UTCRange Source #

data Filter Source #

Constructors

FT_string !RegularExpression
FT_integer !IntRange
FT_utc !UTCRange

Instances

Eq Filter Source #
Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
Show Filter Source #
Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #
Arbitrary Filter Source #
Methods arbitrary :: Gen Filter # shrink :: Filter -> [Filter] #
ToJSON Filter Source #
Methods toJSON :: Filter -> Value # toEncoding :: Filter -> Encoding # toJSONList :: [Filter] -> Value # toEncodingList :: [Filter] -> Encoding #
FromJSON Filter Source #
Methods parseJSON :: Value -> Parser Filter # parseJSONList :: Value -> Parser [Filter] #
NFData Filter Source #
Methods rnf :: Filter -> () #
SafeCopy Filter Source #
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 Source #
Methods encode :: Filter -> Encoding # decode :: Decoder s Filter # encodeList :: [Filter] -> Encoding # decodeList :: Decoder s [Filter] #
Example Filter Source #
Methods example :: Gen Filter Source #
FromJSONWithErrs Filter Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs Filter Source #

data Conversion Source #

Constructors

Conversion
Fields _cv_injection :: !Text _cv_projection :: !Text

Instances

Eq Conversion Source #
Methods (==) :: Conversion -> Conversion -> Bool # (/=) :: Conversion -> Conversion -> Bool #
Show Conversion Source #
Methods showsPrec :: Int -> Conversion -> ShowS # show :: Conversion -> String # showList :: [Conversion] -> ShowS #
Arbitrary Conversion Source #
Methods arbitrary :: Gen Conversion # shrink :: Conversion -> [Conversion] #
ToJSON Conversion Source #
Methods toJSON :: Conversion -> Value # toEncoding :: Conversion -> Encoding # toJSONList :: [Conversion] -> Value # toEncodingList :: [Conversion] -> Encoding #
FromJSON Conversion Source #
Methods parseJSON :: Value -> Parser Conversion # parseJSONList :: Value -> Parser [Conversion] #
NFData Conversion Source #
Methods rnf :: Conversion -> () #
SafeCopy Conversion Source #
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 Source #
Methods encode :: Conversion -> Encoding # decode :: Decoder s Conversion # encodeList :: [Conversion] -> Encoding # decodeList :: Decoder s [Conversion] #
Example Conversion Source #
Methods example :: Gen Conversion Source #
FromJSONWithErrs Conversion Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs Conversion Source #

newtype TypeRef Source #

Constructors

TypeRef
Fields _TypeRef :: Text

Instances

Eq TypeRef Source #
Methods (==) :: TypeRef -> TypeRef -> Bool # (/=) :: TypeRef -> TypeRef -> Bool #
Ord TypeRef Source #
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 Source #
Methods showsPrec :: Int -> TypeRef -> ShowS # show :: TypeRef -> String # showList :: [TypeRef] -> ShowS #
IsString TypeRef Source #
Methods fromString :: String -> TypeRef #
Arbitrary TypeRef Source #
Methods arbitrary :: Gen TypeRef # shrink :: TypeRef -> [TypeRef] #
ToJSON TypeRef Source #
Methods toJSON :: TypeRef -> Value # toEncoding :: TypeRef -> Encoding # toJSONList :: [TypeRef] -> Value # toEncodingList :: [TypeRef] -> Encoding #
FromJSON TypeRef Source #
Methods parseJSON :: Value -> Parser TypeRef # parseJSONList :: Value -> Parser [TypeRef] #
NFData TypeRef Source #
Methods rnf :: TypeRef -> () #
SafeCopy TypeRef Source #
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 Source #
Methods encode :: TypeRef -> Encoding # decode :: Decoder s TypeRef # encodeList :: [TypeRef] -> Encoding # decodeList :: Decoder s [TypeRef] #
Example TypeRef Source #
Methods example :: Gen TypeRef Source #
FromJSONWithErrs TypeRef Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs TypeRef Source #

data BasicType Source #

Constructors

BT_string
BT_binary
BT_boolean
BT_integer
BT_utc

Instances

Bounded BasicType Source #
Methods minBound :: BasicType # maxBound :: BasicType #
Enum BasicType Source #
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 Source #
Methods (==) :: BasicType -> BasicType -> Bool # (/=) :: BasicType -> BasicType -> Bool #
Ord BasicType Source #
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 Source #
Methods showsPrec :: Int -> BasicType -> ShowS # show :: BasicType -> String # showList :: [BasicType] -> ShowS #
Arbitrary BasicType Source #
Methods arbitrary :: Gen BasicType # shrink :: BasicType -> [BasicType] #
ToJSON BasicType Source #
Methods toJSON :: BasicType -> Value # toEncoding :: BasicType -> Encoding # toJSONList :: [BasicType] -> Value # toEncodingList :: [BasicType] -> Encoding #
FromJSON BasicType Source #
Methods parseJSON :: Value -> Parser BasicType # parseJSONList :: Value -> Parser [BasicType] #
NFData BasicType Source #
Methods rnf :: BasicType -> () #
SafeCopy BasicType Source #
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 Source #
Methods encode :: BasicType -> Encoding # decode :: Decoder s BasicType # encodeList :: [BasicType] -> Encoding # decodeList :: Decoder s [BasicType] #
Example BasicType Source #
Methods example :: Gen BasicType Source #
FromJSONWithErrs BasicType Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs BasicType Source #

data APIType Source #

Constructors

TY_list !APIType
TY_maybe !APIType
TY_ref !TypeRef
TY_basic !BasicType
TY_json !Int

Instances

Eq APIType Source #
Methods (==) :: APIType -> APIType -> Bool # (/=) :: APIType -> APIType -> Bool #
Show APIType Source #
Methods showsPrec :: Int -> APIType -> ShowS # show :: APIType -> String # showList :: [APIType] -> ShowS #
Arbitrary APIType Source #
Methods arbitrary :: Gen APIType # shrink :: APIType -> [APIType] #
ToJSON APIType Source #
Methods toJSON :: APIType -> Value # toEncoding :: APIType -> Encoding # toJSONList :: [APIType] -> Value # toEncodingList :: [APIType] -> Encoding #
FromJSON APIType Source #
Methods parseJSON :: Value -> Parser APIType # parseJSONList :: Value -> Parser [APIType] #
NFData APIType Source #
Methods rnf :: APIType -> () #
SafeCopy APIType Source #
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 Source #
Methods encode :: APIType -> Encoding # decode :: Decoder s APIType # encodeList :: [APIType] -> Encoding # decodeList :: Decoder s [APIType] #
Example APIType Source #
Methods example :: Gen APIType Source #
FromJSONWithErrs APIType Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs APIType Source #

data SpecNewtype Source #

Constructors

SpecNewtype
Fields _sn_type :: !BasicType _sn_filter :: !(Maybe Filter)

Instances

Eq SpecNewtype Source #
Methods (==) :: SpecNewtype -> SpecNewtype -> Bool # (/=) :: SpecNewtype -> SpecNewtype -> Bool #
Show SpecNewtype Source #
Methods showsPrec :: Int -> SpecNewtype -> ShowS # show :: SpecNewtype -> String # showList :: [SpecNewtype] -> ShowS #
Arbitrary SpecNewtype Source #
Methods arbitrary :: Gen SpecNewtype # shrink :: SpecNewtype -> [SpecNewtype] #
ToJSON SpecNewtype Source #
Methods toJSON :: SpecNewtype -> Value # toEncoding :: SpecNewtype -> Encoding # toJSONList :: [SpecNewtype] -> Value # toEncodingList :: [SpecNewtype] -> Encoding #
FromJSON SpecNewtype Source #
Methods parseJSON :: Value -> Parser SpecNewtype # parseJSONList :: Value -> Parser [SpecNewtype] #
NFData SpecNewtype Source #
Methods rnf :: SpecNewtype -> () #
SafeCopy SpecNewtype Source #
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 Source #
Methods encode :: SpecNewtype -> Encoding # decode :: Decoder s SpecNewtype # encodeList :: [SpecNewtype] -> Encoding # decodeList :: Decoder s [SpecNewtype] #
Example SpecNewtype Source #
Methods example :: Gen SpecNewtype Source #
FromJSONWithErrs SpecNewtype Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs SpecNewtype Source #

data DefaultValue Source #

Constructors

DV_list !Int
DV_maybe !Int
DV_string !Text
DV_boolean !Bool
DV_integer !Int
DV_utc !UTCTime

Instances

Eq DefaultValue Source #
Methods (==) :: DefaultValue -> DefaultValue -> Bool # (/=) :: DefaultValue -> DefaultValue -> Bool #
Show DefaultValue Source #
Methods showsPrec :: Int -> DefaultValue -> ShowS # show :: DefaultValue -> String # showList :: [DefaultValue] -> ShowS #
Arbitrary DefaultValue Source #
Methods arbitrary :: Gen DefaultValue # shrink :: DefaultValue -> [DefaultValue] #
ToJSON DefaultValue Source #
Methods toJSON :: DefaultValue -> Value # toEncoding :: DefaultValue -> Encoding # toJSONList :: [DefaultValue] -> Value # toEncodingList :: [DefaultValue] -> Encoding #
FromJSON DefaultValue Source #
Methods parseJSON :: Value -> Parser DefaultValue # parseJSONList :: Value -> Parser [DefaultValue] #
NFData DefaultValue Source #
Methods rnf :: DefaultValue -> () #
SafeCopy DefaultValue Source #
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 Source #
Methods encode :: DefaultValue -> Encoding # decode :: Decoder s DefaultValue # encodeList :: [DefaultValue] -> Encoding # decodeList :: Decoder s [DefaultValue] #
Example DefaultValue Source #
Methods example :: Gen DefaultValue Source #
FromJSONWithErrs DefaultValue Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs DefaultValue Source #

data Field Source #

Constructors

Field
Fields _fd_name :: !Text _fd_type :: !APIType _fd_readonly :: !Bool _fd_default :: !(Maybe DefaultValue) _fd_comment :: !Text

Instances

Eq Field Source #
Methods (==) :: Field -> Field -> Bool # (/=) :: Field -> Field -> Bool #
Show Field Source #
Methods showsPrec :: Int -> Field -> ShowS # show :: Field -> String # showList :: [Field] -> ShowS #
Arbitrary Field Source #
Methods arbitrary :: Gen Field # shrink :: Field -> [Field] #
ToJSON Field Source #
Methods toJSON :: Field -> Value # toEncoding :: Field -> Encoding # toJSONList :: [Field] -> Value # toEncodingList :: [Field] -> Encoding #
FromJSON Field Source #
Methods parseJSON :: Value -> Parser Field # parseJSONList :: Value -> Parser [Field] #
NFData Field Source #
Methods rnf :: Field -> () #
SafeCopy Field Source #
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 Source #
Methods encode :: Field -> Encoding # decode :: Decoder s Field # encodeList :: [Field] -> Encoding # decodeList :: Decoder s [Field] #
Example Field Source #
Methods example :: Gen Field Source #
FromJSONWithErrs Field Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs Field Source #

data Spec Source #

Constructors

SP_newtype !SpecNewtype
SP_record ![Field]
SP_union ![Field]
SP_enum ![Text]
SP_synonym !APIType

Instances

Eq Spec Source #
Methods (==) :: Spec -> Spec -> Bool # (/=) :: Spec -> Spec -> Bool #
Show Spec Source #
Methods showsPrec :: Int -> Spec -> ShowS # show :: Spec -> String # showList :: [Spec] -> ShowS #
Arbitrary Spec Source #
Methods arbitrary :: Gen Spec # shrink :: Spec -> [Spec] #
ToJSON Spec Source #
Methods toJSON :: Spec -> Value # toEncoding :: Spec -> Encoding # toJSONList :: [Spec] -> Value # toEncodingList :: [Spec] -> Encoding #
FromJSON Spec Source #
Methods parseJSON :: Value -> Parser Spec # parseJSONList :: Value -> Parser [Spec] #
NFData Spec Source #
Methods rnf :: Spec -> () #
SafeCopy Spec Source #
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 Source #
Methods encode :: Spec -> Encoding # decode :: Decoder s Spec # encodeList :: [Spec] -> Encoding # decodeList :: Decoder s [Spec] #
Example Spec Source #
Methods example :: Gen Spec Source #
FromJSONWithErrs Spec Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs Spec Source #

data APINode Source #

Constructors

APINode
Fields _an_name :: !Text _an_comment :: !Text _an_prefix :: !Text _an_spec :: !Spec _an_convert :: !(Maybe Conversion)

Instances

Eq APINode Source #
Methods (==) :: APINode -> APINode -> Bool # (/=) :: APINode -> APINode -> Bool #
Show APINode Source #
Methods showsPrec :: Int -> APINode -> ShowS # show :: APINode -> String # showList :: [APINode] -> ShowS #
Arbitrary APINode Source #
Methods arbitrary :: Gen APINode # shrink :: APINode -> [APINode] #
ToJSON APINode Source #
Methods toJSON :: APINode -> Value # toEncoding :: APINode -> Encoding # toJSONList :: [APINode] -> Value # toEncodingList :: [APINode] -> Encoding #
FromJSON APINode Source #
Methods parseJSON :: Value -> Parser APINode # parseJSONList :: Value -> Parser [APINode] #
NFData APINode Source #
Methods rnf :: APINode -> () #
SafeCopy APINode Source #
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 Source #
Methods encode :: APINode -> Encoding # decode :: Decoder s APINode # encodeList :: [APINode] -> Encoding # decodeList :: Decoder s [APINode] #
Example APINode Source #
Methods example :: Gen APINode Source #
FromJSONWithErrs APINode Source #
Methods parseJSONWithErrs :: Value -> ParserWithErrs APINode Source #