-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | servant-docs/servant-auth compatibility
--   
--   This package provides instances that allow generating docs from
--   <a>servant</a> APIs that use <a>servant-auth's</a> <tt>Auth</tt>
--   combinator.
--   
--   For a quick overview of the usage, see the <a>README</a>.
@package servant-auth-docs
@version 0.2.10.0

module Servant.Auth.Docs

-- | A JSON Web Token (JWT) in the the Authorization header:
--   
--   <pre>
--   Authorization: Bearer <a>token</a>
--   </pre>
--   
--   Note that while the token is signed, it is not encrypted. Therefore do
--   not keep in it any information you would not like the client to know.
--   
--   JWTs are described in IETF's <a>RFC 7519</a>
data JWT

-- | Basic Auth.
data BasicAuth

-- | A cookie. The content cookie itself is a JWT. Another cookie is also
--   used, the contents of which are expected to be send back to the server
--   in a header, for XSRF protection.
data Cookie

-- | <tt>Auth [auth1, auth2] val :&gt; api</tt> represents an API protected
--   *either* by <tt>auth1</tt> or <tt>auth2</tt>
data Auth (auths :: [*]) val
instance (Servant.Auth.Docs.OneDoc a, Servant.Auth.Docs.AllDocs as) => Servant.Auth.Docs.AllDocs (a : as)
instance Servant.Auth.Docs.OneDoc Servant.Auth.JWT
instance Servant.Auth.Docs.OneDoc Servant.Auth.Cookie
instance Servant.Auth.Docs.OneDoc Servant.Auth.BasicAuth
instance (Servant.Auth.Docs.AllDocs auths, Servant.Docs.Internal.HasDocs api) => Servant.Docs.Internal.HasDocs (Servant.Auth.Auth auths r Servant.API.Sub.:> api)
instance Servant.Auth.Docs.AllDocs '[]
