Browse Source

etcdhttp: rename Members -> members in JSON, update doc

Jonathan Boulle 11 years ago
parent
commit
14852662ef
2 changed files with 26 additions and 47 deletions
  1. 25 46
      Documentation/0.5/admin_api.md
  2. 1 1
      etcdserver/etcdhttp/http.go

+ 25 - 46
Documentation/0.5/admin_api.md

@@ -1,30 +1,7 @@
 ## Admin API
 
-### GET /v2/admin/members/:id
-Returns an HTTP 200 OK response code and a representation of the requested member; returns a 404 status code and an error message if the id does not exist.
-```
-    Example Request: GET 
-                     http://localhost:2379/v2/admin/members/272e204152
-    Response formats: JSON
-    Example Response:
-```
-```json
-    [
-        {
-            "ID":"272e204152",
-            "Name":"node1",
-            "PeerURLs":[
-                "http://10.0.0.10:2379"
-            ],
-            "ClientURLs":[
-                "http://10.0.0.10:2380"
-            ]
-        },
-    ]
-```
-
 ### GET /v2/admin/members/
-Return an HTTP 200 OK response code and a representation of all the members;
+Return an HTTP 200 OK response code and a representation of all members in the etcd cluster:
 ```
     Example Request: GET 
                      http://localhost:2379/v2/admin/members/
@@ -32,28 +9,30 @@ Return an HTTP 200 OK response code and a representation of all the members;
     Example Response:
 ```
 ```json
-    [
-        {
-            "ID":"272e204152",
-            "Name":"node1",
-            "PeerURLs":[
-                "http://10.0.0.10:2379"
-            ],
-            "ClientURLs":[
-                "http://10.0.0.10:2380"
-            ]
-        },
-        {
-            "ID":"2225373f43",
-            "Name":"node2",
-            "PeerURLs":[
-                "http://127.0.0.11:2379"
-            ],
-            "ClientURLs":[
-                "http://127.0.0.11:2380"
-            ]
-        },
-    ]
+    {
+        "members": [
+                {
+                    "ID":"272e204152",
+                    "Name":"node1",
+                    "PeerURLs":[
+                        "http://10.0.0.10:2379"
+                    ],
+                    "ClientURLs":[
+                            "http://10.0.0.10:2380"
+                    ]
+                },
+                {
+                    "ID":"2225373f43",
+                    "Name":"node2",
+                    "PeerURLs":[
+                        "http://127.0.0.11:2379"
+                    ],
+                    "ClientURLs":[
+                        "http://127.0.0.11:2380"
+                    ]
+            },
+        ]
+    }
 ```
 
 ### POST /v2/admin/members/

+ 1 - 1
etcdserver/etcdhttp/http.go

@@ -166,7 +166,7 @@ func (h serverHandler) serveAdminMembers(w http.ResponseWriter, r *http.Request)
 			return
 		}
 		ms := struct {
-			Members []*etcdserver.Member
+			Members []*etcdserver.Member `json:"members"`
 		}{
 			Members: h.clusterInfo.Members(),
 		}