Safe Haskell	Safe
Language	Haskell2010

Servant.API.Description

Synopsis

Documentation

data Description sym Source #

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 :}

data Summary sym Source #

Add a short summary for (part of) API.

Example:

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