From c7da1ba9dc256f10e5393e9e806030b318fc3f49 Mon Sep 17 00:00:00 2001 From: aaron levin Date: Wed, 12 Aug 2015 20:20:18 -0400 Subject: [PATCH] Small haddocks changes for authentication --- .../auth-combinator/auth-combinator.hs | 27 +++++++------------ .../Servant/Server/Internal/Authentication.hs | 4 +-- 2 files changed, 11 insertions(+), 20 deletions(-) diff --git a/servant-examples/auth-combinator/auth-combinator.hs b/servant-examples/auth-combinator/auth-combinator.hs index cd315703..b48c0480 100644 --- a/servant-examples/auth-combinator/auth-combinator.hs +++ b/servant-examples/auth-combinator/auth-combinator.hs @@ -1,19 +1,13 @@ -{-# LANGUAGE DataKinds #-} -{-# LANGUAGE DeriveGeneric #-} -{-# LANGUAGE FlexibleInstances #-} -{-# LANGUAGE OverloadedStrings #-} -{-# LANGUAGE ScopedTypeVariables #-} -{-# LANGUAGE TypeFamilies #-} -{-# LANGUAGE TypeOperators #-} +-- | An example of a custom authentication framework that checks a Cookie for a +-- value. -import Data.Aeson -import Data.ByteString (ByteString) -import Data.Text (Text) -import GHC.Generics -import Network.Wai -import Network.Wai.Handler.Warp -import Servant -import Servant.Server.Internal +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE TypeOperators #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} import Data.Aeson import Data.ByteString (ByteString) import Data.ByteString.Builder.Internal (byteStringCopy) @@ -28,9 +22,6 @@ import Servant.API.Authentication import Servant.Server.Internal import Servant.Server.Internal.Authentication (strictProtect, AuthHandlers(AuthHandlers)) --- | An example of a custom authentication framework that checks a Cookie for a --- value. - -- | Data we will use to test for authentication data CookieAuth = CookieAuth { cookie :: ByteString } diff --git a/servant-server/src/Servant/Server/Internal/Authentication.hs b/servant-server/src/Servant/Server/Internal/Authentication.hs index f050969c..dfad221a 100644 --- a/servant-server/src/Servant/Server/Internal/Authentication.hs +++ b/servant-server/src/Servant/Server/Internal/Authentication.hs @@ -60,13 +60,13 @@ data instance AuthProtected authData usr subserver 'Lax = , subServerLax :: subserver } --- | handy function to build an auth-protected bit of API with a Lax policy +-- | handy function to build an auth-protected bit of API with a 'Lax' policy laxProtect :: (authData -> IO (Maybe usr)) -- ^ check auth -> subserver -- ^ the handlers for the auth-aware bits of the API -> AuthProtected authData usr subserver 'Lax laxProtect = AuthProtectedLax --- | handy function to build an auth-protected bit of API with a Strict policy +-- | handy function to build an auth-protected bit of API with a 'Strict' policy strictProtect :: (authData -> IO (Maybe usr)) -- ^ check auth -> AuthHandlers authData -- ^ functions to call on auth failure -> subserver -- ^ handlers for the auth-protected bits of the API