diff --git a/Documentation/0.5/other_apis.md b/Documentation/0.5/other_apis.md index 80a86247b..10e506edc 100644 --- a/Documentation/0.5/other_apis.md +++ b/Documentation/0.5/other_apis.md @@ -1,10 +1,10 @@ -## Admin API +## Members API -### GET /v2/admin/members/ +### GET /v2/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/ + http://localhost:2379/v2/members/ Response formats: JSON Example Response: ``` @@ -35,14 +35,14 @@ Return an HTTP 200 OK response code and a representation of all members in the e } ``` -### POST /v2/admin/members/ +### POST /v2/members/ Add a member to the cluster. Returns an HTTP 201 response code and the representation of added member with a newly generated a memberID when successful. Returns a string describing the failure condition when unsuccessful. If the POST body is malformed an HTTP 400 will be returned. If the member exists in the cluster or existed in the cluster at some point in the past an HTTP 500(TODO: fix this) will be returned. If the cluster fails to process the request within timeout an HTTP 500 will be returned, though the request may be processed later. ``` Example Request: POST - http://localhost:2379/v2/admin/members + http://localhost:2379/v2/members Body: {"peerURLs":["http://10.0.0.10:2379"]} Respose formats: JSON @@ -57,7 +57,7 @@ If the POST body is malformed an HTTP 400 will be returned. If the member exists } ``` -### DELETE /v2/admin/members/:id +### DELETE /v2/members/:id Remove a member from the cluster. Returns empty when successful. Returns a string describing the failure condition when unsuccessful. @@ -65,6 +65,6 @@ If the member does not exist in the cluster an HTTP 500(TODO: fix this) will be ``` Response formats: JSON Example Request: DELETE - http://localhost:2379/v2/admin/members/272e204152 + http://localhost:2379/v2/members/272e204152 Example Response: Empty ``` diff --git a/client/members.go b/client/members.go index 3e7616cbb..e8b4c96fd 100644 --- a/client/members.go +++ b/client/members.go @@ -28,7 +28,7 @@ import ( ) var ( - DefaultV2MembersPrefix = "/v2/admin/members" + DefaultV2MembersPrefix = "/v2/members" ) func NewMembersAPI(tr *http.Transport, ep string, to time.Duration) (MembersAPI, error) { diff --git a/client/members_test.go b/client/members_test.go index e061fc004..b8cdd2bc4 100644 --- a/client/members_test.go +++ b/client/members_test.go @@ -23,11 +23,11 @@ import ( ) func TestMembersAPIListAction(t *testing.T) { - ep := url.URL{Scheme: "http", Host: "example.com/v2/admin/members"} + ep := url.URL{Scheme: "http", Host: "example.com/v2/members"} wantURL := &url.URL{ Scheme: "http", Host: "example.com", - Path: "/v2/admin/members", + Path: "/v2/members", } act := &membersAPIActionList{} diff --git a/etcdserver/etcdhttp/client.go b/etcdserver/etcdhttp/client.go index f35e5fdd5..cd42e7647 100644 --- a/etcdserver/etcdhttp/client.go +++ b/etcdserver/etcdhttp/client.go @@ -43,7 +43,7 @@ import ( const ( keysPrefix = "/v2/keys" deprecatedMachinesPrefix = "/v2/machines" - adminMembersPrefix = "/v2/admin/members" + membersPrefix = "/v2/members" statsPrefix = "/v2/stats" versionPrefix = "/version" ) @@ -61,7 +61,7 @@ func NewClientHandler(server *etcdserver.EtcdServer) http.Handler { stats: server, } - amh := &adminMembersHandler{ + mh := &membersHandler{ server: server, clusterInfo: server.Cluster, clock: clockwork.NewRealClock(), @@ -79,8 +79,8 @@ func NewClientHandler(server *etcdserver.EtcdServer) http.Handler { mux.HandleFunc(statsPrefix+"/store", sh.serveStore) mux.HandleFunc(statsPrefix+"/self", sh.serveSelf) mux.HandleFunc(statsPrefix+"/leader", sh.serveLeader) - mux.Handle(adminMembersPrefix, amh) - mux.Handle(adminMembersPrefix+"/", amh) + mux.Handle(membersPrefix, mh) + mux.Handle(membersPrefix+"/", mh) mux.Handle(deprecatedMachinesPrefix, dmh) return mux } @@ -142,13 +142,13 @@ func (h *deprecatedMachinesHandler) ServeHTTP(w http.ResponseWriter, r *http.Req w.Write([]byte(strings.Join(endpoints, ", "))) } -type adminMembersHandler struct { +type membersHandler struct { server etcdserver.Server clusterInfo etcdserver.ClusterInfo clock clockwork.Clock } -func (h *adminMembersHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { +func (h *membersHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { if !allowMethod(w, r.Method, "GET", "POST", "DELETE") { return } @@ -160,7 +160,7 @@ func (h *adminMembersHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) switch r.Method { case "GET": - if trimPrefix(r.URL.Path, adminMembersPrefix) != "" { + if trimPrefix(r.URL.Path, membersPrefix) != "" { writeError(w, httptypes.NewHTTPError(http.StatusNotFound, "Not found")) return } @@ -202,7 +202,7 @@ func (h *adminMembersHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) log.Printf("etcdhttp: %v", err) } case "DELETE": - idStr := trimPrefix(r.URL.Path, adminMembersPrefix) + idStr := trimPrefix(r.URL.Path, membersPrefix) if idStr == "" { http.Error(w, "Method Not Allowed", http.StatusMethodNotAllowed) return diff --git a/etcdserver/etcdhttp/client_test.go b/etcdserver/etcdhttp/client_test.go index 1abcbe7da..ae3a42acd 100644 --- a/etcdserver/etcdhttp/client_test.go +++ b/etcdserver/etcdhttp/client_test.go @@ -556,7 +556,7 @@ func TestServeAdminMembers(t *testing.T) { id: 1, members: map[uint64]*etcdserver.Member{1: &memb1, 2: &memb2}, } - h := &adminMembersHandler{ + h := &membersHandler{ server: &serverRecorder{}, clock: clockwork.NewFakeClock(), clusterInfo: cluster, @@ -570,10 +570,10 @@ func TestServeAdminMembers(t *testing.T) { wct string wbody string }{ - {adminMembersPrefix, http.StatusOK, "application/json", wmc + "\n"}, - {adminMembersPrefix + "/", http.StatusOK, "application/json", wmc + "\n"}, - {path.Join(adminMembersPrefix, "100"), http.StatusNotFound, "application/json", `{"message":"Not found"}`}, - {path.Join(adminMembersPrefix, "foobar"), http.StatusNotFound, "application/json", `{"message":"Not found"}`}, + {membersPrefix, http.StatusOK, "application/json", wmc + "\n"}, + {membersPrefix + "/", http.StatusOK, "application/json", wmc + "\n"}, + {path.Join(membersPrefix, "100"), http.StatusNotFound, "application/json", `{"message":"Not found"}`}, + {path.Join(membersPrefix, "foobar"), http.StatusNotFound, "application/json", `{"message":"Not found"}`}, } for i, tt := range tests { @@ -602,7 +602,7 @@ func TestServeAdminMembers(t *testing.T) { } func TestServeAdminMembersCreate(t *testing.T) { - u := mustNewURL(t, adminMembersPrefix) + u := mustNewURL(t, membersPrefix) b := []byte(`{"peerURLs":["http://127.0.0.1:1"]}`) req, err := http.NewRequest("POST", u.String(), bytes.NewReader(b)) if err != nil { @@ -610,7 +610,7 @@ func TestServeAdminMembersCreate(t *testing.T) { } req.Header.Set("Content-Type", "application/json") s := &serverRecorder{} - h := &adminMembersHandler{ + h := &membersHandler{ server: s, clock: clockwork.NewFakeClock(), clusterInfo: &fakeCluster{id: 1}, @@ -656,10 +656,10 @@ func TestServeAdminMembersCreate(t *testing.T) { func TestServeAdminMembersDelete(t *testing.T) { req := &http.Request{ Method: "DELETE", - URL: mustNewURL(t, path.Join(adminMembersPrefix, "BEEF")), + URL: mustNewURL(t, path.Join(membersPrefix, "BEEF")), } s := &serverRecorder{} - h := &adminMembersHandler{ + h := &membersHandler{ server: s, clusterInfo: &fakeCluster{id: 1}, } @@ -714,7 +714,7 @@ func TestServeAdminMembersFail(t *testing.T) { { // parse body error &http.Request{ - URL: mustNewURL(t, adminMembersPrefix), + URL: mustNewURL(t, membersPrefix), Method: "POST", Body: ioutil.NopCloser(strings.NewReader("bad json")), Header: map[string][]string{"Content-Type": []string{"application/json"}}, @@ -726,7 +726,7 @@ func TestServeAdminMembersFail(t *testing.T) { { // bad content type &http.Request{ - URL: mustNewURL(t, adminMembersPrefix), + URL: mustNewURL(t, membersPrefix), Method: "POST", Body: ioutil.NopCloser(strings.NewReader(`{"PeerURLs": ["http://127.0.0.1:1"]}`)), Header: map[string][]string{"Content-Type": []string{"application/bad"}}, @@ -738,7 +738,7 @@ func TestServeAdminMembersFail(t *testing.T) { { // bad url &http.Request{ - URL: mustNewURL(t, adminMembersPrefix), + URL: mustNewURL(t, membersPrefix), Method: "POST", Body: ioutil.NopCloser(strings.NewReader(`{"PeerURLs": ["http://a"]}`)), Header: map[string][]string{"Content-Type": []string{"application/json"}}, @@ -750,7 +750,7 @@ func TestServeAdminMembersFail(t *testing.T) { { // etcdserver.AddMember error &http.Request{ - URL: mustNewURL(t, adminMembersPrefix), + URL: mustNewURL(t, membersPrefix), Method: "POST", Body: ioutil.NopCloser(strings.NewReader(`{"PeerURLs": ["http://127.0.0.1:1"]}`)), Header: map[string][]string{"Content-Type": []string{"application/json"}}, @@ -764,7 +764,7 @@ func TestServeAdminMembersFail(t *testing.T) { { // etcdserver.RemoveMember error &http.Request{ - URL: mustNewURL(t, path.Join(adminMembersPrefix, "1")), + URL: mustNewURL(t, path.Join(membersPrefix, "1")), Method: "DELETE", }, &errServer{ @@ -776,7 +776,7 @@ func TestServeAdminMembersFail(t *testing.T) { { // etcdserver.RemoveMember error &http.Request{ - URL: mustNewURL(t, adminMembersPrefix), + URL: mustNewURL(t, membersPrefix), Method: "DELETE", }, nil, @@ -785,7 +785,7 @@ func TestServeAdminMembersFail(t *testing.T) { }, } for i, tt := range tests { - h := &adminMembersHandler{ + h := &membersHandler{ server: tt.server, clusterInfo: &fakeCluster{id: 1}, clock: clockwork.NewFakeClock(), @@ -1552,9 +1552,9 @@ func TestTrimPrefix(t *testing.T) { prefix string w string }{ - {"/v2/admin/members", "/v2/admin/members", ""}, - {"/v2/admin/members/", "/v2/admin/members", ""}, - {"/v2/admin/members/foo", "/v2/admin/members", "foo"}, + {"/v2/members", "/v2/members", ""}, + {"/v2/members/", "/v2/members", ""}, + {"/v2/members/foo", "/v2/members", "foo"}, } for i, tt := range tests { if g := trimPrefix(tt.in, tt.prefix); g != tt.w {