Add basic doc for AdminAPI module (#93)

This commit is contained in:
Krishnan Parthasarathi 2018-06-04 13:25:02 -07:00 committed by Aditya Manthramurthy
parent 952c0b0342
commit bf27848046

View File

@ -15,7 +15,11 @@
-- --
module Network.Minio.AdminAPI module Network.Minio.AdminAPI
( ErasureSets(..) ( -- * Minio Admin API
--------------------
-- | Provides Minio admin API and related types. It is in
-- experimental state.
ErasureSets(..)
, ErasureInfo(..) , ErasureInfo(..)
, Backend(..) , Backend(..)
, ConnStats(..) , ConnStats(..)
@ -203,6 +207,9 @@ instance FromJSON ServerInfo where
adminPath :: ByteString adminPath :: ByteString
adminPath = "/minio/admin" adminPath = "/minio/admin"
-- | Fetches information for all cluster nodes, such as server
-- properties, storage information, network statistics, etc.
getServerInfo :: Minio [ServerInfo] getServerInfo :: Minio [ServerInfo]
getServerInfo = do getServerInfo = do
rsp <- executeAdminRequest AdminReqInfo { ariMethod = HT.methodGet rsp <- executeAdminRequest AdminReqInfo { ariMethod = HT.methodGet