From a091b1a3eefbaea07499bef9a5462280ec9d2a7a Mon Sep 17 00:00:00 2001 From: Harshavardhana Date: Thu, 2 Aug 2018 14:21:38 -0700 Subject: [PATCH] Fix admin API doc formatting (#6235) --- docs/zh_CN/admin-api/README.md | 76 ---------------------------------- pkg/madmin/API.md | 6 +-- 2 files changed, 3 insertions(+), 79 deletions(-) delete mode 100644 docs/zh_CN/admin-api/README.md diff --git a/docs/zh_CN/admin-api/README.md b/docs/zh_CN/admin-api/README.md deleted file mode 100644 index 12e88ed26..000000000 --- a/docs/zh_CN/admin-api/README.md +++ /dev/null @@ -1,76 +0,0 @@ -# 管理REST API - -## 认证 -- AWS signatureV4 -- 我们使用`minio`作为区域。 这里区域仅用于签名计算。 - -##管理接口 -- Service - - Restart - - Status - - SetCredentials - -- Locks - - List - - Clear - -- Healing - -### 服务管理接口 -* Restart - - POST /?service - - x-minio-operation: restart - - Response: On success 200 - -* Status - - GET /?service - - x-minio-operation: status - - Response: On success 200, return json formatted object which contains StorageInfo and ServerVersion structures - -* SetCredentials - - GET /?service - - x-minio-operation: set-credentials - - Response: Success 200 - - Possible error responses - - ErrMethodNotAllowed - ```xml - - MethodNotAllowed - The specified method is not allowed against this resource. - - - / - 3L137 - 3L137 - - ``` - - ErrAdminBadCred - ```xml - - XMinioBadCred - XMinioBadCred - - - / - 3L137 - 3L137 - - ``` - - ErrInternalError - ```xml - - InternalError - We encountered an internal error, please try again. - - - / - 3L137 - 3L137 - - ``` - -### 修复 - -* ListBucketsHeal - - GET /?heal - - x-minio-operation: list-buckets diff --git a/pkg/madmin/API.md b/pkg/madmin/API.md index 6d8556934..bd0de0435 100644 --- a/pkg/madmin/API.md +++ b/pkg/madmin/API.md @@ -37,9 +37,9 @@ func main() { ``` | Service operations | Info operations | Healing operations | Config operations | Misc | -|:------------------------------------|:----------------------------|:----------------------------|:--------------------------------------|:--------------------------|:------------------------------------| -| [`ServiceStatus`](#ServiceStatus) | [`ServerInfo`](#ServerInfo) | [`Heal`](#Heal) | [`GetConfig`](#GetConfig) | [`SetCredentials`](#SetCredentials) | -| [`ServiceSendAction`](#ServiceSendAction) | | | [`SetConfig`](#SetConfig) | | +|:----------------------------|:----------------------------|:--------------------------------------|:--------------------------|:------------------------------------| +| [`ServiceStatus`](#ServiceStatus) | [`ServerInfo`](#ServerInfo) | [`Heal`](#Heal) | [`GetConfig`](#GetConfig) | [`SetCredentials`](#SetCredentials) | +| [`ServiceSendAction`](#ServiceSendAction) | | | [`SetConfig`](#SetConfig) | | ## 1. Constructor