Safe Haskell	None
Language	Haskell2010

Hasura.RQL.DDL.Webhook.Transform.QueryParams

Synopsis

newtype QueryParams = QueryParams {
- unQueryParams :: Query
}
newtype QueryParamsTransformFn = AddOrReplace [(UnescapedTemplate, Maybe UnescapedTemplate)]
applyQueryParamsTransformFn :: MonadError TransformErrorBundle m => QueryParamsTransformFn -> RequestTransformCtx -> QueryParams -> m QueryParams
validateQueryParamsTransformFn :: TemplatingEngine -> QueryParamsTransformFn -> Validation TransformErrorBundle ()

Documentation

newtype QueryParams Source #

The actual query params we are transforming.

This newtype is necessary because otherwise we end up with an orphan instance.

Constructors

QueryParams
Fields unQueryParams :: Query

Instances

Instances details

Transform QueryParams Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Associated Types data TransformFn QueryParams Source # Methods transform :: MonadError TransformErrorBundle m => TransformFn QueryParams -> RequestTransformCtx -> QueryParams -> m QueryParams Source # validate :: TemplatingEngine -> TransformFn QueryParams -> Validation TransformErrorBundle () Source #
Eq (TransformFn QueryParams) Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods (==) :: TransformFn QueryParams -> TransformFn QueryParams -> Bool # (/=) :: TransformFn QueryParams -> TransformFn QueryParams -> Bool #
Show (TransformFn QueryParams) Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods showsPrec :: Int -> TransformFn QueryParams -> ShowS # show :: TransformFn QueryParams -> String # showList :: [TransformFn QueryParams] -> ShowS #
Generic (TransformFn QueryParams) Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Associated Types type Rep (TransformFn QueryParams) :: Type -> Type # Methods from :: TransformFn QueryParams -> Rep (TransformFn QueryParams) x # to :: Rep (TransformFn QueryParams) x -> TransformFn QueryParams #
NFData (TransformFn QueryParams) Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods rnf :: TransformFn QueryParams -> () #
FromJSON (TransformFn QueryParams) Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods parseJSON :: Value -> Parser (TransformFn QueryParams) parseJSONList :: Value -> Parser [TransformFn QueryParams]
ToJSON (TransformFn QueryParams) Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods toJSON :: TransformFn QueryParams -> Value toEncoding :: TransformFn QueryParams -> Encoding toJSONList :: [TransformFn QueryParams] -> Value toEncodingList :: [TransformFn QueryParams] -> Encoding
Cacheable (TransformFn QueryParams) Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods unchanged :: Accesses -> TransformFn QueryParams -> TransformFn QueryParams -> Bool Source #
newtype TransformFn QueryParams Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams newtype TransformFn QueryParams = QueryParamsTransformFn_ QueryParamsTransformFn
type Rep (TransformFn QueryParams) Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams type Rep (TransformFn QueryParams) = D1 ('MetaData "TransformFn" "Hasura.RQL.DDL.Webhook.Transform.QueryParams" "graphql-engine-1.0.0-inplace" 'True) (C1 ('MetaCons "QueryParamsTransformFn_" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 QueryParamsTransformFn)))

newtype QueryParamsTransformFn Source #

The defunctionalized transformation QueryParams

Constructors

AddOrReplace [(UnescapedTemplate, Maybe UnescapedTemplate)]

Instances

Instances details

Eq QueryParamsTransformFn Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods (==) :: QueryParamsTransformFn -> QueryParamsTransformFn -> Bool # (/=) :: QueryParamsTransformFn -> QueryParamsTransformFn -> Bool #
Show QueryParamsTransformFn Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods showsPrec :: Int -> QueryParamsTransformFn -> ShowS # show :: QueryParamsTransformFn -> String # showList :: [QueryParamsTransformFn] -> ShowS #
Generic QueryParamsTransformFn Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Associated Types type Rep QueryParamsTransformFn :: Type -> Type # Methods from :: QueryParamsTransformFn -> Rep QueryParamsTransformFn x # to :: Rep QueryParamsTransformFn x -> QueryParamsTransformFn #
NFData QueryParamsTransformFn Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods rnf :: QueryParamsTransformFn -> () #
FromJSON QueryParamsTransformFn Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods parseJSON :: Value -> Parser QueryParamsTransformFn parseJSONList :: Value -> Parser [QueryParamsTransformFn]
ToJSON QueryParamsTransformFn Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods toJSON :: QueryParamsTransformFn -> Value toEncoding :: QueryParamsTransformFn -> Encoding toJSONList :: [QueryParamsTransformFn] -> Value toEncodingList :: [QueryParamsTransformFn] -> Encoding
Cacheable QueryParamsTransformFn Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams Methods unchanged :: Accesses -> QueryParamsTransformFn -> QueryParamsTransformFn -> Bool Source #
type Rep QueryParamsTransformFn Source #
Instance details Defined in Hasura.RQL.DDL.Webhook.Transform.QueryParams type Rep QueryParamsTransformFn = D1 ('MetaData "QueryParamsTransformFn" "Hasura.RQL.DDL.Webhook.Transform.QueryParams" "graphql-engine-1.0.0-inplace" 'True) (C1 ('MetaCons "AddOrReplace" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(UnescapedTemplate, Maybe UnescapedTemplate)])))

applyQueryParamsTransformFn :: MonadError TransformErrorBundle m => QueryParamsTransformFn -> RequestTransformCtx -> QueryParams -> m QueryParams Source #

Provide an implementation for the transformations defined by QueryParamsTransformFn.

If one views QueryParamsTransformFn as an interface describing HTTP method transformations, this can be seen as an implementation of these transformations as normal Haskell functions.

validateQueryParamsTransformFn :: TemplatingEngine -> QueryParamsTransformFn -> Validation TransformErrorBundle () Source #

Validate that the provided QueryParamsTransformFn is correct in the context of a particular TemplatingEngine.

This is a product of the fact that the correctness of a given transformation may be dependent on zero, one, or more of the templated transformations encoded within the given QueryParamsTransformFn.