Add basic doc for AdminAPI module (minio#93)

ebozduman · Jun 4, 2018 · bf27848 · bf27848
1 parent 952c0b0
commit bf27848
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/src/Network/Minio/AdminAPI.hs b/src/Network/Minio/AdminAPI.hs
@@ -15,7 +15,11 @@
 --
 
 module Network.Minio.AdminAPI
-  ( ErasureSets(..)
+  ( -- * Minio Admin API
+    --------------------
+    -- | Provides Minio admin API and related types. It is in
+    -- experimental state.
+    ErasureSets(..)
   , ErasureInfo(..)
   , Backend(..)
   , ConnStats(..)
@@ -203,6 +207,9 @@ instance FromJSON ServerInfo where
 adminPath :: ByteString
 adminPath = "/minio/admin"
 
+-- | Fetches information for all cluster nodes, such as server
+-- properties, storage information, network statistics, etc.
+
 getServerInfo :: Minio [ServerInfo]
 getServerInfo = do
     rsp <- executeAdminRequest AdminReqInfo { ariMethod = HT.methodGet