eeva/servant
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

improved description of BasicAuth lookup

Browse source
This commit is contained in:
aaron levin 2015-05-11 18:16:53 -04:00 committed by Arian van Putten
parent 4add59bbd1
commit ca88a72bde
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
servant/src/Servant/API/Authentication.hs
View file

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