servant-docs-0.11: generate API docs for your servant webservice

Safe HaskellNone
LanguageHaskell2010

Servant.Docs.Internal.Pretty

Synopsis

Documentation

pretty :: Proxy api -> Proxy (Pretty api) Source #

Prettify generated JSON documentation.

docs (pretty (Proxy :: Proxy MyAPI))

type family Pretty (api :: k) :: k where ... Source #

Replace all JSON content types with PrettyJSON. Kind-polymorphic so it can operate on kinds * and [*].

Equations

Pretty (x :<|> y) = Pretty x :<|> Pretty y 
Pretty (x :> y) = Pretty x :> Pretty y 
Pretty (Get cs r) = Get (Pretty cs) r 
Pretty (Post cs r) = Post (Pretty cs) r 
Pretty (Put cs r) = Put (Pretty cs) r 
Pretty (Delete cs r) = Delete (Pretty cs) r 
Pretty (Patch cs r) = Patch (Pretty cs) r 
Pretty (ReqBody cs r) = ReqBody (Pretty cs) r 
Pretty (JSON ': xs) = PrettyJSON ': xs 
Pretty (x ': xs) = x ': Pretty xs 
Pretty x = x