improved description of BasicAuth lookup

This commit is contained in:
aaron levin 2015-05-11 18:16:53 -04:00 committed by Arian van Putten
parent 4add59bbd1
commit ca88a72bde

View file

@ -11,8 +11,7 @@ import GHC.TypeLits (Symbol)
-- type to encapsulate authentication logic.
--
-- Example:
-- >>> type AuthLookup = Text -> IO User
-- >>> type MyApi = BasicAuth "book-realm" :> "books" :> Get '[JSON] [Book]
-- >>> type MyApi = BasicAuth "book-realm" DB :> "books" :> Get '[JSON] [Book]
data BasicAuth (realm :: Symbol) lookup
deriving (Typeable)
@ -20,6 +19,6 @@ data BasicAuth (realm :: Symbol) lookup
-- >>> import Servant.API
-- >>> import Data.Aeson
-- >>> import Data.Text
-- >>> data User
-- >>> data DB
-- >>> data Book
-- >>> instance ToJSON Book where { toJSON = undefined }