git.iko.soy/gogol
on develop help sign in
Reorganising some minor Haddock documentation
commit8ceaeb9e5772d65a9fa154b7a7245d31cd5293dd authorBrendan Hay <brendan.g.hay@gmail.com> dateMon 19 Oct 2015, 17:34 (11 years ago) parent6b605b3
2 files changed+16−10
compare with develop
unifiedsplit
gogol/src/Network/Google.hs+9−8 gogol/src/Network/Google/Compute/Metadata.hs+7−2
gogol/src/Network/Google.hs+9−8
@@ -27,13 +27,14 @@ module Network.Google
2727 (
2828 -- * Running Google Actions
2929 Google
30+ , MonadGoogle (..)
3031 , runGoogle
3132 , runResourceT
3233
3334 -- * Authentication and Environment
3435 , newEnv
3536 , Env
36− , HasEnv (..)
37+ , HasEnv (..)
3738
3839 -- ** Credential Discovery
3940 , Credentials (..)
@@ -55,23 +56,23 @@ module Network.Google
5556
5657 -- ** Media Uploads
5758 , Body
58− , ToBody (..)
59− , OctetStream
60− , PlainText
61− , JSON
59+ , ToBody (..)
6260
6361 -- * Running Asynchronous Actions
6462 -- $async
6563
6664 -- * Handling Errors
67− , AsError (..)
68− , AsAuthError (..)
65+ , AsError (..)
66+ , AsAuthError (..)
6967
7068 , trying
7169 , catching
7270
7371 -- * Re-exported Types
74− , Proxy (..)
72+ , Proxy (..)
73+ , OctetStream
74+ , PlainText
75+ , JSON
7576 , module Network.Google.Types
7677 ) where
7778
gogol/src/Network/Google/Compute/Metadata.hs+7−2
@@ -9,8 +9,10 @@
99-- Portability : non-portable (GHC extensions)
1010--
1111-- Google Compute Engine defines a set of default metadata entries that provide
12−-- information about your instance or project. Default metadata is always defined
13−-- and set by the server. You cannot manually edit any of these metadata pairs.
12+-- information about your instance or project.
13+--
14+-- This module contains functions for retrieving various Compute metadata from an
15+-- instance's local metadata endpoint using 'MonadIO' and not the Google monad.
1416module Network.Google.Compute.Metadata
1517 (
1618 -- * Google Compute Instance Check
@@ -55,12 +57,15 @@ import qualified Network.HTTP.Conduit as Client
5557import Network.HTTP.Types
5658import System.Environment (lookupEnv)
5759
60+-- | @NO_GCE_CHECK@.
5861checkGCEVar :: String
5962checkGCEVar = "NO_GCE_CHECK"
6063
64+-- | The @Metadata-Flavor@ header.
6165metadataFlavorHeader :: HeaderName
6266metadataFlavorHeader = "Metadata-Flavor"
6367
68+-- | The desired metadata flavor.
6469metadataFlavorDesired :: ByteString
6570metadataFlavorDesired = "Google"
6671