Servant.API.Sub

Documentation

data (path :: k) :> a infixr 4

The contained API (second argument) can be found under ("/" ++ path) (path being the first argument).

Example:

>>> -- GET /hello/world
>>> -- returning a JSON encoded World value
>>> type MyApi = "hello" :> "world" :> Get '[JSON] World

Instances

HasLink k2 sub => HasLink * ((:>) * k2 (AuthProtect k1 tag) sub)

Associated Types

type MkLink ((* :> k2) (AuthProtect k1 tag) sub) (endpoint :: (* :> k2) (AuthProtect k1 tag) sub) :: *

Methods

toLink :: Proxy ((* :> k2) (AuthProtect k1 tag) sub) endpoint -> Link -> MkLink ((* :> k2) (AuthProtect k1 tag) sub) endpoint

HasLink k sub => HasLink * ((:>) * k (BasicAuth realm a) sub)

Associated Types

type MkLink ((* :> k) (BasicAuth realm a) sub) (endpoint :: (* :> k) (BasicAuth realm a) sub) :: *

Methods

toLink :: Proxy ((* :> k) (BasicAuth realm a) sub) endpoint -> Link -> MkLink ((* :> k) (BasicAuth realm a) sub) endpoint

HasLink k sub => HasLink * ((:>) * k RemoteHost sub)

Associated Types

type MkLink ((* :> k) RemoteHost sub) (endpoint :: (* :> k) RemoteHost sub) :: *

Methods

toLink :: Proxy ((* :> k) RemoteHost sub) endpoint -> Link -> MkLink ((* :> k) RemoteHost sub) endpoint

HasLink k sub => HasLink * ((:>) * k (Header sym a) sub)

Associated Types

type MkLink ((* :> k) (Header sym a) sub) (endpoint :: (* :> k) (Header sym a) sub) :: *

Methods

toLink :: Proxy ((* :> k) (Header sym a) sub) endpoint -> Link -> MkLink ((* :> k) (Header sym a) sub) endpoint

(ToHttpApiData v, HasLink k sub) => HasLink * ((:>) * k (CaptureAll * sym v) sub)

Associated Types

type MkLink ((* :> k) (CaptureAll * sym v) sub) (endpoint :: (* :> k) (CaptureAll * sym v) sub) :: *

Methods

toLink :: Proxy ((* :> k) (CaptureAll * sym v) sub) endpoint -> Link -> MkLink ((* :> k) (CaptureAll * sym v) sub) endpoint

(ToHttpApiData v, HasLink k sub) => HasLink * ((:>) * k (Capture * sym v) sub)

Associated Types

type MkLink ((* :> k) (Capture * sym v) sub) (endpoint :: (* :> k) (Capture * sym v) sub) :: *

Methods

toLink :: Proxy ((* :> k) (Capture * sym v) sub) endpoint -> Link -> MkLink ((* :> k) (Capture * sym v) sub) endpoint

HasLink k2 sub => HasLink * ((:>) * k2 (ReqBody k1 ct a) sub)

Associated Types

type MkLink ((* :> k2) (ReqBody k1 ct a) sub) (endpoint :: (* :> k2) (ReqBody k1 ct a) sub) :: *

Methods

toLink :: Proxy ((* :> k2) (ReqBody k1 ct a) sub) endpoint -> Link -> MkLink ((* :> k2) (ReqBody k1 ct a) sub) endpoint

(KnownSymbol sym, HasLink k sub) => HasLink * ((:>) * k (QueryFlag sym) sub)

Associated Types

type MkLink ((* :> k) (QueryFlag sym) sub) (endpoint :: (* :> k) (QueryFlag sym) sub) :: *

Methods

toLink :: Proxy ((* :> k) (QueryFlag sym) sub) endpoint -> Link -> MkLink ((* :> k) (QueryFlag sym) sub) endpoint

(KnownSymbol sym, ToHttpApiData v, HasLink k sub) => HasLink * ((:>) * k (QueryParams * sym v) sub)

Associated Types

type MkLink ((* :> k) (QueryParams * sym v) sub) (endpoint :: (* :> k) (QueryParams * sym v) sub) :: *

Methods

toLink :: Proxy ((* :> k) (QueryParams * sym v) sub) endpoint -> Link -> MkLink ((* :> k) (QueryParams * sym v) sub) endpoint

(KnownSymbol sym, ToHttpApiData v, HasLink k sub) => HasLink * ((:>) * k (QueryParam * sym v) sub)

Associated Types

type MkLink ((* :> k) (QueryParam * sym v) sub) (endpoint :: (* :> k) (QueryParam * sym v) sub) :: *

Methods

toLink :: Proxy ((* :> k) (QueryParam * sym v) sub) endpoint -> Link -> MkLink ((* :> k) (QueryParam * sym v) sub) endpoint

(KnownSymbol sym, HasLink k sub) => HasLink * ((:>) Symbol k sym sub)

Associated Types

type MkLink ((Symbol :> k) sym sub) (endpoint :: (Symbol :> k) sym sub) :: *

Methods

toLink :: Proxy ((Symbol :> k) sym sub) endpoint -> Link -> MkLink ((Symbol :> k) sym sub) endpoint

type MkLink * ((:>) * k1 (AuthProtect k2 tag) sub)

type MkLink * ((:>) * k1 (AuthProtect k2 tag) sub) = MkLink k1 sub

type MkLink * ((:>) * k (BasicAuth realm a) sub)

type MkLink * ((:>) * k (BasicAuth realm a) sub) = MkLink k sub

type MkLink * ((:>) * k RemoteHost sub)

type MkLink * ((:>) * k RemoteHost sub) = MkLink k sub

type MkLink * ((:>) * k (Header sym a) sub)

type MkLink * ((:>) * k (Header sym a) sub) = MkLink k sub

type MkLink * ((:>) * k (CaptureAll * sym v) sub)

type MkLink * ((:>) * k (CaptureAll * sym v) sub) = [v] -> MkLink k sub

type MkLink * ((:>) * k (Capture * sym v) sub)

type MkLink * ((:>) * k (Capture * sym v) sub) = v -> MkLink k sub

type MkLink * ((:>) * k1 (ReqBody k2 ct a) sub)

type MkLink * ((:>) * k1 (ReqBody k2 ct a) sub) = MkLink k1 sub

type MkLink * ((:>) * k (QueryFlag sym) sub)

type MkLink * ((:>) * k (QueryFlag sym) sub) = Bool -> MkLink k sub

type MkLink * ((:>) * k (QueryParams * sym v) sub)

type MkLink * ((:>) * k (QueryParams * sym v) sub) = [v] -> MkLink k sub

type MkLink * ((:>) * k (QueryParam * sym v) sub)

type MkLink * ((:>) * k (QueryParam * sym v) sub) = Maybe v -> MkLink k sub

type MkLink * ((:>) Symbol k sym sub)

type MkLink * ((:>) Symbol k sym sub) = MkLink k sub