From 14852662ef21a2e25d51c7bbea9c4c5b0f5c45c0 Mon Sep 17 00:00:00 2001 From: Jonathan Boulle Date: Fri, 24 Oct 2014 10:50:47 -0700 Subject: [PATCH] etcdhttp: rename Members -> members in JSON, update doc --- Documentation/0.5/admin_api.md | 71 ++++++++++++---------------------- etcdserver/etcdhttp/http.go | 2 +- 2 files changed, 26 insertions(+), 47 deletions(-) diff --git a/Documentation/0.5/admin_api.md b/Documentation/0.5/admin_api.md index beaafa3b6..0ec26658d 100644 --- a/Documentation/0.5/admin_api.md +++ b/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/ diff --git a/etcdserver/etcdhttp/http.go b/etcdserver/etcdhttp/http.go index ec0afbe25..ab69dc1c3 100644 --- a/etcdserver/etcdhttp/http.go +++ b/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(), }