servant-docs-0.13: generate API docs for your servant webservice
Safe HaskellSafe-Inferred
LanguageHaskell2010

Servant.Docs.Internal.Pretty

Synopsis

Documentation

data PrettyJSON Source #

PrettyJSON content type.

Instances

Instances details
Accept PrettyJSON Source # 
Instance details

Defined in Servant.Docs.Internal.Pretty

Methods

contentType :: Proxy PrettyJSON -> MediaType Source #

contentTypes :: Proxy PrettyJSON -> NonEmpty MediaType Source #

ToJSON a => MimeRender PrettyJSON a Source # 
Instance details

Defined in Servant.Docs.Internal.Pretty

Methods

mimeRender :: Proxy PrettyJSON -> a -> ByteString Source #

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 (GetPartialContent cs r) = GetPartialContent (Pretty cs) r 
Pretty (PutResetContent cs r) = PutResetContent (Pretty cs) r 
Pretty (PatchResetContent cs r) = PatchResetContent (Pretty cs) r 
Pretty (DeleteResetContent cs r) = DeleteResetContent (Pretty cs) r 
Pretty (PostResetContent cs r) = PostResetContent (Pretty cs) r 
Pretty (GetResetContent cs r) = GetResetContent (Pretty cs) r 
Pretty (PutNonAuthoritative cs r) = PutNonAuthoritative (Pretty cs) r 
Pretty (PatchNonAuthoritative cs r) = PatchNonAuthoritative (Pretty cs) r 
Pretty (DeleteNonAuthoritative cs r) = DeleteNonAuthoritative (Pretty cs) r 
Pretty (PostNonAuthoritative cs r) = PostNonAuthoritative (Pretty cs) r 
Pretty (GetNonAuthoritative cs r) = GetNonAuthoritative (Pretty cs) r 
Pretty (PutAccepted cs r) = PutAccepted (Pretty cs) r 
Pretty (PatchAccepted cs r) = PatchAccepted (Pretty cs) r 
Pretty (DeleteAccepted cs r) = DeleteAccepted (Pretty cs) r 
Pretty (PostAccepted cs r) = PostAccepted (Pretty cs) r 
Pretty (GetAccepted cs r) = GetAccepted (Pretty cs) r 
Pretty (PutCreated cs r) = PutCreated (Pretty cs) r 
Pretty (PostCreated cs r) = PostCreated (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