Servant.API.Fragment

Documentation

data Fragment (a :: Type)

Document the URI fragment in API. Useful in combination with Link.

Example:

>>> -- /post#TRACKING
>>> type MyApi = "post" :> Fragment Text :> Get '[JSON] Tracking

Instances

(HasLink sub, ToHttpApiData v) => HasLink (Fragment v :> sub :: Type)

Defined in Servant.Links

Associated Types

type MkLink (Fragment v :> sub) a

Methods

toLink :: (Link -> a) -> Proxy (Fragment v :> sub) -> Link -> MkLink (Fragment v :> sub) a

AtMostOneFragment (Fragment a)

Defined in Servant.API.TypeLevel

type MkLink (Fragment v :> sub :: Type) a

Defined in Servant.Links

type MkLink (Fragment v :> sub :: Type) a = v -> MkLink sub a