on develop help sign in
Rewording scope helpers
4c4e3dcBrendan Hay
gogol/src/Network/Google/Auth/Scope.hs+7−7
@@ -35,21 +35,21 @@ import Network.Google.Prelude (GoogleRequest (..),
35 OAuthScope (..))
35 OAuthScope (..))
36import Network.HTTP.Types (urlEncode)
36import Network.HTTP.Types (urlEncode)
37
37
38−-- | Type-restrict the supplied credentials etc. to the specific scopes.
38+-- | Annotate credentials with the specified scopes.
39--
39--
40−-- This simply exists to allow users to choose between using 'getCredentials'
40+-- This exists to allow users to choose between using 'getCredentials'
41+-- with a 'Proxy' type constructed via use of '(!)', or explicitly
41−-- with a 'Proxy' type, or explicitly specifying the type annotation without
42+-- specifying the scopes in a type annotation.
42−-- having separate functions.
43--
43--
44−-- /See:/ '!'.
44+-- /See:/ '!' and the related scopes available for each service.
45allow :: proxy s -> k s -> k s
45allow :: proxy s -> k s -> k s
46allow _ = id
46allow _ = id
47
47
48−-- | Type-restrict the supplied credentials (etc.) to no scopes.
48+-- | Annotate credentials with no scope authorization.
49forbid :: k '[] -> k '[]
49forbid :: k '[] -> k '[]
50forbid = id
50forbid = id
51
51
52−-- | Append the type-level lists of two 'Proxy' values.
52+-- | Append two sets of scopes.
53--
53--
54-- /See:/ 'allow'.
54-- /See:/ 'allow'.
55(!) :: proxy xs -> proxy ys -> Proxy (xs ++ ys)
55(!) :: proxy xs -> proxy ys -> Proxy (xs ++ ys)