From 574b667c5639079da8e8c3cad2fad5d8cbee7224 Mon Sep 17 00:00:00 2001
From: Nitish Tiwari <nitish@minio.io>
Date: Tue, 13 Mar 2018 00:21:58 +0530
Subject: [PATCH] Remove madmin docs from top level docs directory (#5636)

madmin package is well documented in its source directory here
https://github.com/minio/minio/tree/master/pkg/madmin.

Hence, keeping another copy is not required as it makes it difficult
to maintain.
---
 docs/admin-api/README.md | 131 ---------------------------------------
 1 file changed, 131 deletions(-)
 delete mode 100644 docs/admin-api/README.md

diff --git a/docs/admin-api/README.md b/docs/admin-api/README.md
deleted file mode 100644
index b197ab859..000000000
--- a/docs/admin-api/README.md
+++ /dev/null
@@ -1,131 +0,0 @@
-# Management REST API
-
-## Authentication
-- AWS signatureV4
-- We use "minio" as region. Here region is set only for signature calculation.
-
-## List of management APIs
-- Service
-  - Restart
-  - Status
-  - SetCredentials
-
-- Locks
-  - List
-  - Clear
-
-- Healing
-
-### Service Management APIs
-* 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
-    <Error>
-        <Code>MethodNotAllowed</Code>
-        <Message>The specified method is not allowed against this resource.</Message>
-        <Key></Key>
-        <BucketName></BucketName>
-        <Resource>/</Resource>
-        <RequestId>3L137</RequestId>
-        <HostId>3L137</HostId>
-    </Error>
-    ```
-    - ErrAdminBadCred
-    ```xml
-    <Error>
-        <Code>XMinioBadCred</Code>
-        <Message>XMinioBadCred</Message>
-        <Key></Key>
-        <BucketName></BucketName>
-        <Resource>/</Resource>
-        <RequestId>3L137</RequestId>
-        <HostId>3L137</HostId>
-    </Error>
-    ```
-    - ErrInternalError
-    ```xml
-    <Error>
-        <Code>InternalError</Code>
-        <Message>We encountered an internal error, please try again.</Message>
-        <Key></Key>
-        <BucketName></BucketName>
-        <Resource>/</Resource>
-        <RequestId>3L137</RequestId>
-        <HostId>3L137</HostId>
-    </Error>
-    ```
-
-
-### Lock Management APIs
-* ListLocks
-  - GET /?lock&bucket=mybucket&prefix=myprefix&duration=duration
-  - x-minio-operation: list
-  - Response: On success 200, json encoded response containing all locks held, for longer than duration.
-  - Possible error responses
-    - ErrInvalidBucketName
-    ```xml
-    <Error>
-        <Code>InvalidBucketName</Code>
-        <Message>The specified bucket is not valid.</Message>
-        <Key></Key>
-        <BucketName></BucketName>
-        <Resource>/</Resource>
-        <RequestId>3L137</RequestId>
-        <HostId>3L137</HostId>
-    </Error>
-    ```
-    - ErrInvalidObjectName
-    ```xml
-    <Error>
-        <Code>XMinioInvalidObjectName</Code>
-        <Message>Object name contains unsupported characters. Unsupported characters are `^*|\&#34;</Message>
-        <Key></Key>
-        <BucketName></BucketName>
-        <Resource>/</Resource>
-        <RequestId>3L137</RequestId>
-        <HostId>3L137</HostId>
-    </Error>
-    ```
-
-    - ErrInvalidDuration
-      ```xml
-      <Error>
-          <Code>InvalidDuration</Code>
-          <Message>Duration provided in the request is invalid.</Message>
-          <Key></Key>
-          <BucketName></BucketName>
-          <Resource>/</Resource>
-          <RequestId>3L137</RequestId>
-          <HostId>3L137</HostId>
-      </Error>
-      ```
-
-
-* ClearLocks
-  - POST /?lock&bucket=mybucket&prefix=myprefix&duration=duration
-  - x-minio-operation: clear
-  - Response: On success 200, json encoded response containing all locks cleared, for longer than duration.
-  - Possible error responses, similar to errors listed in ListLocks.
-    - ErrInvalidBucketName
-    - ErrInvalidObjectName
-    - ErrInvalidDuration
-
-### Healing
-
-* ListBucketsHeal
-  - GET /?heal
-  - x-minio-operation: list-buckets