From bf27848046d551cd7d501eafe892812fa736c179 Mon Sep 17 00:00:00 2001 From: Krishnan Parthasarathi Date: Mon, 4 Jun 2018 13:25:02 -0700 Subject: [PATCH] Add basic doc for AdminAPI module (#93) --- src/Network/Minio/AdminAPI.hs | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/Network/Minio/AdminAPI.hs b/src/Network/Minio/AdminAPI.hs index ac80a2e..075b6a9 100644 --- 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