Safe Haskell	None
Language	Haskell2010

Servant.Docs.Internal.Pretty

Synopsis

data PrettyJSON
pretty :: forall {k} (api :: k). Proxy api -> Proxy (Pretty api)
type family Pretty (api :: k) :: k where ...

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 # contentTypes :: Proxy PrettyJSON -> NonEmpty MediaType #
ToJSON a => MimeRender PrettyJSON a Source #
Instance details Defined in Servant.Docs.Internal.Pretty Methods mimeRender :: Proxy PrettyJSON -> a -> ByteString #

pretty :: forall {k} (api :: k). 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 :: Type) = Pretty x :<\|> Pretty y
Pretty (x :> y :: Type) = Pretty x :> Pretty y
Pretty (Get cs r :: Type) = Get (Pretty cs) r
Pretty (Post cs r :: Type) = Post (Pretty cs) r
Pretty (Put cs r :: Type) = Put (Pretty cs) r
Pretty (Delete cs r :: Type) = Delete (Pretty cs) r
Pretty (Patch cs r :: Type) = Patch (Pretty cs) r
Pretty (GetPartialContent cs r :: Type) = GetPartialContent (Pretty cs) r
Pretty (PutResetContent cs r :: Type) = PutResetContent (Pretty cs) r
Pretty (PatchResetContent cs r :: Type) = PatchResetContent (Pretty cs) r
Pretty (DeleteResetContent cs r :: Type) = DeleteResetContent (Pretty cs) r
Pretty (PostResetContent cs r :: Type) = PostResetContent (Pretty cs) r
Pretty (GetResetContent cs r :: Type) = GetResetContent (Pretty cs) r
Pretty (PutNonAuthoritative cs r :: Type) = PutNonAuthoritative (Pretty cs) r
Pretty (PatchNonAuthoritative cs r :: Type) = PatchNonAuthoritative (Pretty cs) r
Pretty (DeleteNonAuthoritative cs r :: Type) = DeleteNonAuthoritative (Pretty cs) r
Pretty (PostNonAuthoritative cs r :: Type) = PostNonAuthoritative (Pretty cs) r
Pretty (GetNonAuthoritative cs r :: Type) = GetNonAuthoritative (Pretty cs) r
Pretty (PutAccepted cs r :: Type) = PutAccepted (Pretty cs) r
Pretty (PatchAccepted cs r :: Type) = PatchAccepted (Pretty cs) r
Pretty (DeleteAccepted cs r :: Type) = DeleteAccepted (Pretty cs) r
Pretty (PostAccepted cs r :: Type) = PostAccepted (Pretty cs) r
Pretty (GetAccepted cs r :: Type) = GetAccepted (Pretty cs) r
Pretty (PutCreated cs r :: Type) = PutCreated (Pretty cs) r
Pretty (PostCreated cs r :: Type) = PostCreated (Pretty cs) r
Pretty (ReqBody cs r :: Type) = ReqBody (Pretty cs) r
Pretty (JSON ': xs :: [Type]) = PrettyJSON ': xs
Pretty (x ': xs :: [a]) = x ': Pretty xs
Pretty (x :: k) = x