Servant.API.Description

Combinators

data Description (sym :: Symbol)

Add more verbose description for (part of) API.

Example:

>>> :{
type MyApi = Description
 "This comment is visible in multiple Servant interpretations \
 \and can be really long if necessary. \
 \Haskell multiline support is not perfect \
 \but it's still very readable."
:> Get '[JSON] Book
:}

Instances

HasLink * sub => HasLink * ((:>) * (Description s) sub)

Associated Types

type MkLink ((* :> Description s) sub) (endpoint :: (* :> Description s) sub) a :: *

Methods

toLink :: (Link -> a) -> Proxy ((* :> Description s) sub) endpoint -> Link -> MkLink ((* :> Description s) sub) endpoint a

type MkLink * ((:>) * (Description s) sub) a

type MkLink * ((:>) * (Description s) sub) a = MkLink * sub a

data Summary (sym :: Symbol)

Add a short summary for (part of) API.

Example:

>>> type MyApi = Summary "Get book by ISBN." :> "books" :> Capture "isbn" Text :> Get '[JSON] Book

Instances

HasLink * sub => HasLink * ((:>) * (Summary s) sub)

Associated Types

type MkLink ((* :> Summary s) sub) (endpoint :: (* :> Summary s) sub) a :: *

Methods

toLink :: (Link -> a) -> Proxy ((* :> Summary s) sub) endpoint -> Link -> MkLink ((* :> Summary s) sub) endpoint a

type MkLink * ((:>) * (Summary s) sub) a

type MkLink * ((:>) * (Summary s) sub) a = MkLink * sub a

Used as modifiers

type FoldDescription mods = FoldDescription' "" mods

Fold modifier list to decide whether argument should be parsed strictly or leniently.

>>> :kind! FoldDescription '[]
FoldDescription '[] :: Symbol
= ""

>>> :kind! FoldDescription '[Required, Description "foobar", Lenient]
FoldDescription '[Required, Description "foobar", Lenient] :: Symbol
= "foobar"

type family FoldDescription' (acc :: Symbol) (mods :: [*]) :: Symbol where ...

Implementation of FoldDescription.

Equations

FoldDescription' acc '[] = acc

FoldDescription' acc (Description desc ': mods) = FoldDescription' desc mods

FoldDescription' acc (mod ': mods) = FoldDescription' acc mods

reflectDescription :: forall mods. KnownSymbol (FoldDescription mods) => Proxy mods -> String

Reflect description to the term level.

>>> reflectDescription (Proxy :: Proxy '[Required, Description "foobar", Lenient])
"foobar"