Update endpoint naming in cluster-service API (#3304)

* Update endpoint naming "pull-request" / "deletion-pull-request"
* Group endpoints in the API docs
* Tidy up comments

---------

Co-authored-by: Simon Howe <[email protected]>
Co-authored-by: Simon <[email protected]>

Author: Sara Elzayat

cmd/clusters-service/api/cluster_services.proto

@@ -278,7 +278,7 @@ func (s *server) CreatePullRequest(ctx context.Context, msg *capiv1_proto.Create
 	}, nil
 }
 
-func (s *server) DeleteClustersPullRequest(ctx context.Context, msg *capiv1_proto.DeleteClustersPullRequestRequest) (*capiv1_proto.DeleteClustersPullRequestResponse, error) {
+func (s *server) CreateDeletionPullRequest(ctx context.Context, msg *capiv1_proto.CreateDeletionPullRequestRequest) (*capiv1_proto.CreateDeletionPullRequestResponse, error) {
 	gp, err := getGitProvider(ctx, msg.RepositoryUrl)
 	if err != nil {
 		return nil, grpcStatus.Errorf(codes.Unauthenticated, "error creating pull request: %s", err.Error())
@@ -395,7 +395,7 @@ func (s *server) DeleteClustersPullRequest(ctx context.Context, msg *capiv1_prot
 		return nil, err
 	}
 
-	return &capiv1_proto.DeleteClustersPullRequestResponse{
+	return &capiv1_proto.CreateDeletionPullRequestResponse{
 		WebUrl: res.WebURL,
 	}, nil
 }
@@ -880,7 +880,7 @@ func validateCreateClusterPR(msg *capiv1_proto.CreatePullRequestRequest) error {
 	return err
 }
 
-func validateDeleteClustersPR(msg *capiv1_proto.DeleteClustersPullRequestRequest) error {
+func validateDeleteClustersPR(msg *capiv1_proto.CreateDeletionPullRequestRequest) error {
 	var err error
 
 	if len(msg.ClusterNamespacedNames) == 0 && len(msg.ClusterNames) == 0 {

cmd/clusters-service/api/cluster_services.swagger.json

@@ -1823,21 +1823,21 @@ func TestDeleteClustersPullRequest(t *testing.T) {
 	testCases := []struct {
 		name           string
 		provider       csgit.Provider
-		req            *capiv1_protos.DeleteClustersPullRequestRequest
+		req            *capiv1_protos.CreateDeletionPullRequestRequest
 		CommittedFiles []*capiv1_protos.CommitFile
 		expected       string
 		err            error
 	}{
 		{
 			name: "validation errors",
-			req:  &capiv1_protos.DeleteClustersPullRequestRequest{},
+			req:  &capiv1_protos.CreateDeletionPullRequestRequest{},
 			err:  errors.New(deleteClustersRequiredErr),
 		},
 
 		{
 			name:     "create delete pull request",
 			provider: gitfakes.NewFakeGitProvider("https://github.com/org/repo/pull/1", nil, nil, nil, nil),
-			req: &capiv1_protos.DeleteClustersPullRequestRequest{
+			req: &capiv1_protos.CreateDeletionPullRequestRequest{
 				ClusterNames:  []string{"foo", "bar"},
 				RepositoryUrl: "https://github.com/org/repo.git",
 				HeadBranch:    "feature-02",
@@ -1854,7 +1854,7 @@ func TestDeleteClustersPullRequest(t *testing.T) {
 				"clusters/default/foo/kustomization.yaml",
 				"clusters/management/clusters/default/foo.yaml",
 			}, nil),
-			req: &capiv1_protos.DeleteClustersPullRequestRequest{
+			req: &capiv1_protos.CreateDeletionPullRequestRequest{
 				ClusterNames:  []string{"foo"},
 				RepositoryUrl: "https://github.com/org/repo.git",
 				HeadBranch:    "feature-02",
@@ -1868,7 +1868,7 @@ func TestDeleteClustersPullRequest(t *testing.T) {
 		{
 			name:     "create delete pull request with namespaced cluster names",
 			provider: gitfakes.NewFakeGitProvider("https://github.com/org/repo/pull/1", nil, nil, nil, nil),
-			req: &capiv1_protos.DeleteClustersPullRequestRequest{
+			req: &capiv1_protos.CreateDeletionPullRequestRequest{
 				ClusterNamespacedNames: []*capiv1_protos.ClusterNamespacedName{
 					testNewClusterNamespacedName(t, "foo", "ns-foo"),
 					testNewClusterNamespacedName(t, "bar", "ns-bar"),
@@ -1888,7 +1888,7 @@ func TestDeleteClustersPullRequest(t *testing.T) {
 				"clusters/ns-foo/foo/kustomization.yaml",
 				"clusters/management/clusters/ns-foo/foo.yaml",
 			}, nil),
-			req: &capiv1_protos.DeleteClustersPullRequestRequest{
+			req: &capiv1_protos.CreateDeletionPullRequestRequest{
 				ClusterNamespacedNames: []*capiv1_protos.ClusterNamespacedName{
 					{
 						Name:      "foo",
@@ -1915,7 +1915,7 @@ func TestDeleteClustersPullRequest(t *testing.T) {
 			})
 
 			// delete request
-			deletePullRequestResponse, err := s.DeleteClustersPullRequest(context.Background(), tt.req)
+			deletePullRequestResponse, err := s.CreateDeletionPullRequest(context.Background(), tt.req)
 
 			// Check the response looks good
 			if err != nil {

cmd/clusters-service/pkg/protos/cluster_services.pb.go

@@ -153,7 +153,7 @@ func TestGitProviderToken(t *testing.T) {
 
 	httpmock.RegisterResponder(
 		http.MethodPost,
-		"http://localhost:8000/v1/clusters",
+		"http://localhost:8000/v1/templates/pull-request",
 		func(r *http.Request) (*http.Response, error) {
 			h, ok := r.Header["Git-Provider-Token"]
 			assert.True(t, ok)
@@ -226,7 +226,7 @@ func TestParseProfiles_ValidRequest(t *testing.T) {
 
 	httpmock.RegisterResponder(
 		http.MethodPost,
-		"http://localhost:8000/v1/clusters",
+		"http://localhost:8000/v1/templates/pull-request",
 		func(r *http.Request) (*http.Response, error) {
 			h, ok := r.Header["Git-Provider-Token"]
 			assert.True(t, ok)
@@ -263,7 +263,7 @@ func TestParseProfiles_InvalidKey(t *testing.T) {
 
 	httpmock.RegisterResponder(
 		http.MethodPost,
-		"http://localhost:8000/v1/clusters",
+		"http://localhost:8000/v1/templates/pull-request",
 		func(r *http.Request) (*http.Response, error) {
 			h, ok := r.Header["Git-Provider-Token"]
 			assert.True(t, ok)
@@ -300,7 +300,7 @@ func TestParseProfiles_InvalidValue(t *testing.T) {
 
 	httpmock.RegisterResponder(
 		http.MethodPost,
-		"http://localhost:8000/v1/clusters",
+		"http://localhost:8000/v1/templates/pull-request",
 		func(r *http.Request) (*http.Response, error) {
 			h, ok := r.Header["Git-Provider-Token"]
 			assert.True(t, ok)

cmd/clusters-service/pkg/protos/cluster_services.pb.gw.go

@@ -33,7 +33,7 @@ func TestPayload(t *testing.T) {
 	defer httpmock.DeactivateAndReset()
 	httpmock.RegisterResponder(
 		http.MethodDelete,
-		"http://localhost:8000/v1/clusters",
+		"http://localhost:8000/v1/templates/deletion-pull-request",
 		func(r *http.Request) (*http.Response, error) {
 			var f interface{}
 			err := json.NewDecoder(r.Body).Decode(&f)
@@ -75,7 +75,7 @@ func TestGitProviderToken(t *testing.T) {
 
 	httpmock.RegisterResponder(
 		http.MethodDelete,
-		"http://localhost:8000/v1/clusters",
+		"http://localhost:8000/v1/templates/deletion-pull-request",
 		func(r *http.Request) (*http.Response, error) {
 			h, ok := r.Header["Git-Provider-Token"]
 			assert.True(t, ok)

cmd/clusters-service/pkg/protos/cluster_services_grpc.pb.go

@@ -22,7 +22,7 @@ func TestGetCluster(t *testing.T) {
 	}{
 		{
 			name:     "cluster kubeconfig",
-			url:      "http://localhost:8000/v1/clusters/dev-cluster/kubeconfig",
+			url:      "http://localhost:8000/v1/namespaces/default/clusters/dev-cluster/kubeconfig",
 			status:   http.StatusOK,
 			response: httpmock.File("../../../pkg/adapters/testdata/cluster_kubeconfig.json"),
 			args: []string{