Safe Haskell	None
Language	Haskell2010

Hasura.RQL.Types.ApiLimit

Synopsis

data ApiLimit = ApiLimit {
- _alRateLimit :: Maybe RateLimit
- _alDepthLimit :: Maybe DepthLimit
- _alNodeLimit :: Maybe NodeLimit
- _alTimeLimit :: Maybe TimeLimit
- _alDisabled :: Bool
}
emptyApiLimit :: ApiLimit
data Limit a = Limit {
- _lGlobal :: a
- _lPerRole :: InsOrdHashMap RoleName a
}
type RateLimit = Limit RateLimitConfig
type DepthLimit = Limit MaxDepth
type NodeLimit = Limit MaxNodes
type TimeLimit = Limit MaxTime
data RateLimitConfig = RateLimitConfig {
- _rlcMaxReqsPerMin :: Int
- _rlcUniqueParams :: Maybe UniqueParamConfig
}
data UniqueParamConfig
- = UPCSessionVar [Text]
- | UPCIpAddress
newtype MaxDepth = MaxDepth {
- unMaxDepth :: Int
}
newtype MaxNodes = MaxNodes {
- unMaxNodes :: Int
}
newtype MaxTime = MaxTime {
- unMaxTime :: Seconds
}

Documentation

data ApiLimit Source #

Constructors

ApiLimit
Fields _alRateLimit :: Maybe RateLimit _alDepthLimit :: Maybe DepthLimit _alNodeLimit :: Maybe NodeLimit _alTimeLimit :: Maybe TimeLimit _alDisabled :: Bool

Instances

Instances details

Eq ApiLimit Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods (==) :: ApiLimit -> ApiLimit -> Bool # (/=) :: ApiLimit -> ApiLimit -> Bool #
Show ApiLimit Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods showsPrec :: Int -> ApiLimit -> ShowS # show :: ApiLimit -> String # showList :: [ApiLimit] -> ShowS #
Generic ApiLimit Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Associated Types type Rep ApiLimit :: Type -> Type # Methods from :: ApiLimit -> Rep ApiLimit x # to :: Rep ApiLimit x -> ApiLimit #
FromJSON ApiLimit Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods parseJSON :: Value -> Parser ApiLimit parseJSONList :: Value -> Parser [ApiLimit]
ToJSON ApiLimit Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods toJSON :: ApiLimit -> Value toEncoding :: ApiLimit -> Encoding toJSONList :: [ApiLimit] -> Value toEncodingList :: [ApiLimit] -> Encoding
type Rep ApiLimit Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit type Rep ApiLimit = D1 ('MetaData "ApiLimit" "Hasura.RQL.Types.ApiLimit" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "ApiLimit" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_alRateLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RateLimit)) :: S1 ('MetaSel ('Just "_alDepthLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DepthLimit))) :: (S1 ('MetaSel ('Just "_alNodeLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeLimit)) :: (S1 ('MetaSel ('Just "_alTimeLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeLimit)) :: S1 ('MetaSel ('Just "_alDisabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

emptyApiLimit :: ApiLimit Source #

data Limit a Source #

Constructors

Limit
Fields _lGlobal :: a _lPerRole :: InsOrdHashMap RoleName a

Instances

Instances details

Eq a => Eq (Limit a) Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods (==) :: Limit a -> Limit a -> Bool # (/=) :: Limit a -> Limit a -> Bool #
Show a => Show (Limit a) Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods showsPrec :: Int -> Limit a -> ShowS # show :: Limit a -> String # showList :: [Limit a] -> ShowS #
Generic (Limit a) Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Associated Types type Rep (Limit a) :: Type -> Type # Methods from :: Limit a -> Rep (Limit a) x # to :: Rep (Limit a) x -> Limit a #
FromJSON a => FromJSON (Limit a) Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods parseJSON :: Value -> Parser (Limit a) parseJSONList :: Value -> Parser [Limit a]
ToJSON a => ToJSON (Limit a) Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods toJSON :: Limit a -> Value toEncoding :: Limit a -> Encoding toJSONList :: [Limit a] -> Value toEncodingList :: [Limit a] -> Encoding
type Rep (Limit a) Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit type Rep (Limit a) = D1 ('MetaData "Limit" "Hasura.RQL.Types.ApiLimit" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "Limit" 'PrefixI 'True) (S1 ('MetaSel ('Just "_lGlobal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "_lPerRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (InsOrdHashMap RoleName a))))

type RateLimit = Limit RateLimitConfig Source #

type DepthLimit = Limit MaxDepth Source #

type NodeLimit = Limit MaxNodes Source #

type TimeLimit = Limit MaxTime Source #

data RateLimitConfig Source #

Constructors

RateLimitConfig
Fields _rlcMaxReqsPerMin :: Int _rlcUniqueParams :: Maybe UniqueParamConfig

Instances

Instances details

Eq RateLimitConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods (==) :: RateLimitConfig -> RateLimitConfig -> Bool # (/=) :: RateLimitConfig -> RateLimitConfig -> Bool #
Show RateLimitConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods showsPrec :: Int -> RateLimitConfig -> ShowS # show :: RateLimitConfig -> String # showList :: [RateLimitConfig] -> ShowS #
Generic RateLimitConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Associated Types type Rep RateLimitConfig :: Type -> Type # Methods from :: RateLimitConfig -> Rep RateLimitConfig x # to :: Rep RateLimitConfig x -> RateLimitConfig #
FromJSON RateLimitConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods parseJSON :: Value -> Parser RateLimitConfig parseJSONList :: Value -> Parser [RateLimitConfig]
ToJSON RateLimitConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods toJSON :: RateLimitConfig -> Value toEncoding :: RateLimitConfig -> Encoding toJSONList :: [RateLimitConfig] -> Value toEncodingList :: [RateLimitConfig] -> Encoding
type Rep RateLimitConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit type Rep RateLimitConfig = D1 ('MetaData "RateLimitConfig" "Hasura.RQL.Types.ApiLimit" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "RateLimitConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "_rlcMaxReqsPerMin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "_rlcUniqueParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UniqueParamConfig))))

data UniqueParamConfig Source #

The unique key using which an authenticated client can be identified

Constructors

UPCSessionVar [Text]	it can be a list of session variable (like session var in `UserInfo`)
UPCIpAddress	or it can be an IP address

Instances

Instances details

Eq UniqueParamConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods (==) :: UniqueParamConfig -> UniqueParamConfig -> Bool # (/=) :: UniqueParamConfig -> UniqueParamConfig -> Bool #
Show UniqueParamConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods showsPrec :: Int -> UniqueParamConfig -> ShowS # show :: UniqueParamConfig -> String # showList :: [UniqueParamConfig] -> ShowS #
Generic UniqueParamConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Associated Types type Rep UniqueParamConfig :: Type -> Type # Methods from :: UniqueParamConfig -> Rep UniqueParamConfig x # to :: Rep UniqueParamConfig x -> UniqueParamConfig #
FromJSON UniqueParamConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods parseJSON :: Value -> Parser UniqueParamConfig parseJSONList :: Value -> Parser [UniqueParamConfig]
ToJSON UniqueParamConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods toJSON :: UniqueParamConfig -> Value toEncoding :: UniqueParamConfig -> Encoding toJSONList :: [UniqueParamConfig] -> Value toEncodingList :: [UniqueParamConfig] -> Encoding
type Rep UniqueParamConfig Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit type Rep UniqueParamConfig = D1 ('MetaData "UniqueParamConfig" "Hasura.RQL.Types.ApiLimit" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "UPCSessionVar" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])) :+: C1 ('MetaCons "UPCIpAddress" 'PrefixI 'False) (U1 :: Type -> Type))

newtype MaxDepth Source #

Constructors

MaxDepth
Fields unMaxDepth :: Int

Instances

Instances details

Eq MaxDepth Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods (==) :: MaxDepth -> MaxDepth -> Bool # (/=) :: MaxDepth -> MaxDepth -> Bool #
Ord MaxDepth Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods compare :: MaxDepth -> MaxDepth -> Ordering # (<) :: MaxDepth -> MaxDepth -> Bool # (<=) :: MaxDepth -> MaxDepth -> Bool # (>) :: MaxDepth -> MaxDepth -> Bool # (>=) :: MaxDepth -> MaxDepth -> Bool # max :: MaxDepth -> MaxDepth -> MaxDepth # min :: MaxDepth -> MaxDepth -> MaxDepth #
Show MaxDepth Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods showsPrec :: Int -> MaxDepth -> ShowS # show :: MaxDepth -> String # showList :: [MaxDepth] -> ShowS #
Generic MaxDepth Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Associated Types type Rep MaxDepth :: Type -> Type # Methods from :: MaxDepth -> Rep MaxDepth x # to :: Rep MaxDepth x -> MaxDepth #
FromJSON MaxDepth Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods parseJSON :: Value -> Parser MaxDepth parseJSONList :: Value -> Parser [MaxDepth]
ToJSON MaxDepth Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods toJSON :: MaxDepth -> Value toEncoding :: MaxDepth -> Encoding toJSONList :: [MaxDepth] -> Value toEncodingList :: [MaxDepth] -> Encoding
type Rep MaxDepth Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit type Rep MaxDepth = D1 ('MetaData "MaxDepth" "Hasura.RQL.Types.ApiLimit" "graphql-engine-1.0.0-inplace" 'True) (C1 ('MetaCons "MaxDepth" 'PrefixI 'True) (S1 ('MetaSel ('Just "unMaxDepth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

newtype MaxNodes Source #

Constructors

MaxNodes
Fields unMaxNodes :: Int

Instances

Instances details

Eq MaxNodes Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods (==) :: MaxNodes -> MaxNodes -> Bool # (/=) :: MaxNodes -> MaxNodes -> Bool #
Ord MaxNodes Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods compare :: MaxNodes -> MaxNodes -> Ordering # (<) :: MaxNodes -> MaxNodes -> Bool # (<=) :: MaxNodes -> MaxNodes -> Bool # (>) :: MaxNodes -> MaxNodes -> Bool # (>=) :: MaxNodes -> MaxNodes -> Bool # max :: MaxNodes -> MaxNodes -> MaxNodes # min :: MaxNodes -> MaxNodes -> MaxNodes #
Show MaxNodes Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods showsPrec :: Int -> MaxNodes -> ShowS # show :: MaxNodes -> String # showList :: [MaxNodes] -> ShowS #
Generic MaxNodes Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Associated Types type Rep MaxNodes :: Type -> Type # Methods from :: MaxNodes -> Rep MaxNodes x # to :: Rep MaxNodes x -> MaxNodes #
FromJSON MaxNodes Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods parseJSON :: Value -> Parser MaxNodes parseJSONList :: Value -> Parser [MaxNodes]
ToJSON MaxNodes Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods toJSON :: MaxNodes -> Value toEncoding :: MaxNodes -> Encoding toJSONList :: [MaxNodes] -> Value toEncodingList :: [MaxNodes] -> Encoding
type Rep MaxNodes Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit type Rep MaxNodes = D1 ('MetaData "MaxNodes" "Hasura.RQL.Types.ApiLimit" "graphql-engine-1.0.0-inplace" 'True) (C1 ('MetaCons "MaxNodes" 'PrefixI 'True) (S1 ('MetaSel ('Just "unMaxNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

newtype MaxTime Source #

Constructors

MaxTime
Fields unMaxTime :: Seconds

Instances

Instances details

Eq MaxTime Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods (==) :: MaxTime -> MaxTime -> Bool # (/=) :: MaxTime -> MaxTime -> Bool #
Ord MaxTime Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods compare :: MaxTime -> MaxTime -> Ordering # (<) :: MaxTime -> MaxTime -> Bool # (<=) :: MaxTime -> MaxTime -> Bool # (>) :: MaxTime -> MaxTime -> Bool # (>=) :: MaxTime -> MaxTime -> Bool # max :: MaxTime -> MaxTime -> MaxTime # min :: MaxTime -> MaxTime -> MaxTime #
Show MaxTime Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods showsPrec :: Int -> MaxTime -> ShowS # show :: MaxTime -> String # showList :: [MaxTime] -> ShowS #
Generic MaxTime Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Associated Types type Rep MaxTime :: Type -> Type # Methods from :: MaxTime -> Rep MaxTime x # to :: Rep MaxTime x -> MaxTime #
FromJSON MaxTime Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods parseJSON :: Value -> Parser MaxTime parseJSONList :: Value -> Parser [MaxTime]
ToJSON MaxTime Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods toJSON :: MaxTime -> Value toEncoding :: MaxTime -> Encoding toJSONList :: [MaxTime] -> Value toEncodingList :: [MaxTime] -> Encoding
ToTxt MaxTime Source #	Defers to the (illegal) DiffTime Show instance. `>>>` `toTxt (MaxTime 2.5)`"2.5s"
Instance details Defined in Hasura.RQL.Types.ApiLimit Methods toTxt :: MaxTime -> Text Source #
type Rep MaxTime Source #
Instance details Defined in Hasura.RQL.Types.ApiLimit type Rep MaxTime = D1 ('MetaData "MaxTime" "Hasura.RQL.Types.ApiLimit" "graphql-engine-1.0.0-inplace" 'True) (C1 ('MetaCons "MaxTime" 'PrefixI 'True) (S1 ('MetaSel ('Just "unMaxTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Seconds)))