Hedgehog.Servant

Documentation

data GList (a :: [*]) where

Data structure used in order to specify generators for API

Example usage:

type Api = "cats" :> ReqBody '[JSON] Cat :> Post '[JSON] ()

catGen :: Gen Cat
catGen = _

genApi :: Gen (BaseUrl -> Request)
genApi = genRequest (Proxy @Api) (catGen :*: GNil)

Constructors

GNil :: GList '[]

(:*:) :: Gen x -> GList xs -> GList (Gen x ': xs) infixr 6

class HasGen (g :: *) (gens :: [*]) where

Simple getter from a GList of possible generators

Methods

getGen :: GList gens -> Gen g

Instances

HasGen h rest => HasGen h (first ': rest)

Defined in Hedgehog.Servant

Methods

getGen :: GList (first ': rest) -> Gen h

HasGen h (Gen h ': rest)

Defined in Hedgehog.Servant

Methods

getGen :: GList (Gen h ': rest) -> Gen h

class GenRequest (api :: *) (gens :: [*]) where

Type class used to generate requests from a 'GList gens' for API api

Methods

genRequest :: Proxy api -> GList gens -> Gen (BaseUrl -> Request)

Instances

(GenRequest a reqs, GenRequest b reqs) => GenRequest (a :<|> b) reqs

Instance for composite APIs

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (a :<|> b) -> GList reqs -> Gen (BaseUrl -> Request)

GenRequest api gens => GenRequest (HttpVersion :> api) gens

This instance doees not do anything right now

Note: in order to use features provided by this type in the API, you'll need to manually adjust the generated request.

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (HttpVersion :> api) -> GList gens -> Gen (BaseUrl -> Request)

GenRequest api gens => GenRequest (BasicAuth x y :> api) gens

This instance doees not do anything right now

Note: in order to use features provided by this type in the API, you'll need to manually adjust the generated request.

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (BasicAuth x y :> api) -> GList gens -> Gen (BaseUrl -> Request)

(ToHttpApiData a, HasGen a gens, GenRequest api gens) => GenRequest (Capture' modifiers sym a :> api) gens

Instance for path capture

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (Capture' modifiers sym a :> api) -> GList gens -> Gen (BaseUrl -> Request)

(ToHttpApiData a, HasGen a gens, GenRequest api gens) => GenRequest (CaptureAll sym a :> api) gens

Instance for capture rest of path, e.g:

type Api = "cats" :> CaptureAll "rest" Text :> Get '[JSON] [Cat]

For simplicity this will generate a number of paths from 0 to 10 linearly

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (CaptureAll sym a :> api) -> GList gens -> Gen (BaseUrl -> Request)

GenRequest api reqs => GenRequest (Description d :> api) reqs

Instance for description

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (Description d :> api) -> GList reqs -> Gen (BaseUrl -> Request)

GenRequest api reqs => GenRequest (Summary s :> api) reqs

Instance for summary

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (Summary s :> api) -> GList reqs -> Gen (BaseUrl -> Request)

(HasGen header gens, KnownSymbol headerName, ToHttpApiData header, GenRequest api gens) => GenRequest (Header' mods headerName header :> api) gens

Instance for headers

Note: this instance currently makes all headers mandatory

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (Header' mods headerName header :> api) -> GList gens -> Gen (BaseUrl -> Request)

GenRequest api gens => GenRequest (IsSecure :> api) gens

This instance doees not do anything right now

Note: in order to use features provided by this type in the API, you'll need to manually adjust the generated request.

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (IsSecure :> api) -> GList gens -> Gen (BaseUrl -> Request)

(KnownSymbol name, GenRequest api gens) => GenRequest (QueryFlag name :> api) gens

Instance for setting query flag

Note: this instance currently makes all query flags mandatory

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (QueryFlag name :> api) -> GList gens -> Gen (BaseUrl -> Request)

(KnownSymbol paramName, ToHttpApiData param, HasGen param gens, GenRequest api gens) => GenRequest (QueryParam' mods paramName param :> api) gens

Instance for setting query parameters

Note: this instance currently makes all query params mandatory

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (QueryParam' mods paramName param :> api) -> GList gens -> Gen (BaseUrl -> Request)

(KnownSymbol paramName, HasGen param gens, ToHttpApiData param, GenRequest api gens) => GenRequest (QueryParams paramName param :> api) gens

Instance for generating query parameters for arrays of values

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (QueryParams paramName param :> api) -> GList gens -> Gen (BaseUrl -> Request)

GenRequest api gens => GenRequest (RemoteHost :> api) gens

This instance doees not do anything right now

Note: in order to use features provided by this type in the API, you'll need to manually adjust the generated request.

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (RemoteHost :> api) -> GList gens -> Gen (BaseUrl -> Request)

(AllMimeRender contentTypes body, HasGen body gens, GenRequest api gens) => GenRequest (ReqBody' mods contentTypes body :> api) gens

Instance for request body

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (ReqBody' mods contentTypes body :> api) -> GList gens -> Gen (BaseUrl -> Request)

GenRequest api gens => GenRequest (Vault :> api) gens

This instance doees not do anything right now

Note: in order to use features provided by this type in the API, you'll need to manually adjust the generated request.

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (Vault :> api) -> GList gens -> Gen (BaseUrl -> Request)

(KnownSymbol path, GenRequest api reqs) => GenRequest (path :> api) reqs

Instance for path part of API

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (path :> api) -> GList reqs -> Gen (BaseUrl -> Request)

GenRequest api gens => GenRequest (WithNamedContext x y api) gens

This instance doees not do anything right now

Note: in order to use features provided by this type in the API, you'll need to manually adjust the generated request.

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (WithNamedContext x y api) -> GList gens -> Gen (BaseUrl -> Request)

ReflectMethod method => GenRequest (Verb method status contentTypes body) gens

Instnace for capturing verb e.g. POST or GET

Defined in Hedgehog.Servant

Methods

genRequest :: Proxy (Verb method status contentTypes body) -> GList gens -> Gen (BaseUrl -> Request)