PMM-12913 migrate /v1/inventory/Agents/Remove

admin/commands/inventory/remove_agent.go

@@ -15,6 +15,7 @@
 package inventory
 
 import (
+	"github.com/AlekSi/pointer"
 	"github.com/percona/pmm/admin/commands"
 	"github.com/percona/pmm/api/inventory/v1/json/client"
 	agents "github.com/percona/pmm/api/inventory/v1/json/client/agents_service"
@@ -41,10 +42,8 @@ type RemoveAgentCommand struct {
 // RunCmd executes the RemoveAgentCommand and returns the result.
 func (cmd *RemoveAgentCommand) RunCmd() (commands.Result, error) {
 	params := &agents.RemoveAgentParams{
-		Body: agents.RemoveAgentBody{
-			AgentID: cmd.AgentID,
-			Force:   cmd.Force,
-		},
+		AgentID: cmd.AgentID,
+		Force:   pointer.ToBool(cmd.Force),
 		Context: commands.Ctx,
 	}
 	_, err := client.Default.AgentsService.RemoveAgent(params)

api-tests/helpers.go

@@ -171,9 +171,7 @@ func RemoveAgents(t TestingT, agentIDs ...string) {
 
 	for _, agentID := range agentIDs {
 		params := &agents.RemoveAgentParams{
-			Body: agents.RemoveAgentBody{
-				AgentID: agentID,
-			},
+			AgentID: agentID,
 			Context: context.Background(),
 		}
 		res, err := client.Default.AgentsService.RemoveAgent(params)

api-tests/inventory/agents_test.go

@@ -284,9 +284,7 @@ func TestPMMAgent(t *testing.T) {
 		}, getAgentRes)
 
 		params := &agents.RemoveAgentParams{
-			Body: agents.RemoveAgentBody{
-				AgentID: agentID,
-			},
+			AgentID: agentID,
 			Context: context.Background(),
 		}
 		removeAgentOK, err := client.Default.AgentsService.RemoveAgent(params)
@@ -353,14 +351,12 @@ func TestPMMAgent(t *testing.T) {
 		mySqldExporterID := mySqldExporter.MysqldExporter.AgentID
 
 		params := &agents.RemoveAgentParams{
-			Body: agents.RemoveAgentBody{
-				AgentID: pmmAgentID,
-			},
+			AgentID: pmmAgentID,
 			Context: context.Background(),
 		}
 		res, err := client.Default.AgentsService.RemoveAgent(params)
 		assert.Nil(t, res)
-		pmmapitests.AssertAPIErrorf(t, err, 400, codes.FailedPrecondition, `pmm-agent with ID %q has agents.`, pmmAgentID)
+		pmmapitests.AssertAPIErrorf(t, err, 400, codes.FailedPrecondition, `pmm-agent with ID %s has agents.`, pmmAgentID)
 
 		// Check that agents aren't removed.
 		getAgentRes, err := client.Default.AgentsService.GetAgent(
@@ -413,10 +409,8 @@ func TestPMMAgent(t *testing.T) {
 
 		// Remove with force flag.
 		params = &agents.RemoveAgentParams{
-			Body: agents.RemoveAgentBody{
-				AgentID: pmmAgentID,
-				Force:   true,
-			},
+			AgentID: pmmAgentID,
+			Force:   pointer.ToBool(true),
 			Context: context.Background(),
 		}
 		res, err = client.Default.AgentsService.RemoveAgent(params)
@@ -445,9 +439,7 @@ func TestPMMAgent(t *testing.T) {
 
 		agentID := "not-exist-pmm-agent"
 		params := &agents.RemoveAgentParams{
-			Body: agents.RemoveAgentBody{
-				AgentID: agentID,
-			},
+			AgentID: agentID,
 			Context: context.Background(),
 		}
 		res, err := client.Default.AgentsService.RemoveAgent(params)
@@ -459,7 +451,6 @@ func TestPMMAgent(t *testing.T) {
 		t.Parallel()
 
 		removeResp, err := client.Default.AgentsService.RemoveAgent(&agents.RemoveAgentParams{
-			Body:    agents.RemoveAgentBody{},
 			Context: context.Background(),
 		})
 		pmmapitests.AssertAPIErrorf(t, err, 400, codes.InvalidArgument, "invalid RemoveAgentRequest.AgentId: value length must be at least 1 runes")
@@ -471,10 +462,8 @@ func TestPMMAgent(t *testing.T) {
 
 		removeResp, err := client.Default.AgentsService.RemoveAgent(
 			&agents.RemoveAgentParams{
-				Body: agents.RemoveAgentBody{
-					AgentID: "pmm-server",
-					Force:   true,
-				},
+				AgentID: "pmm-server",
+				Force:   pointer.ToBool(true),
 				Context: context.Background(),
 			})
 		pmmapitests.AssertAPIErrorf(t, err, 403, codes.PermissionDenied, "pmm-agent on PMM Server can't be removed.")

api/MIGRATION_TO_V3.md

@@ -25,7 +25,7 @@ POST /v1/inventory/Agents/Add                       POST /v1/inventory/agents
 POST /v1/inventory/Agents/Change                    PUT /v1/inventory/agents/{agent_id}              ✅
 POST /v1/inventory/Agents/Get                       GET /v1/inventory/agents/{agent_id}              ✅
 POST /v1/inventory/Agents/List                      GET /v1/inventory/agents                         ✅ Query param filters: service_id, node_id, pmm_agent_id and agent_type
-POST /v1/inventory/Agents/Remove                    DELETE /v1/inventory/agents/{id}
+POST /v1/inventory/Agents/Remove                    DELETE /v1/inventory/agents/{agent_id}           ✅
 POST /v1/inventory/Agents/GetLogs                   GET /v1/inventory/agents/{id}/logs            
 
 **NodesService**                                   **NodesService**

api/inventory/v1/agents.proto

@@ -1365,10 +1365,7 @@ service AgentsService {
 
   // RemoveAgent removes an Agent.
   rpc RemoveAgent(RemoveAgentRequest) returns (RemoveAgentResponse) {
-    option (google.api.http) = {
-      post: "/v1/inventory/Agents/Remove"
-      body: "*"
-    };
+    option (google.api.http) = {delete: "/v1/inventory/agents/{agent_id}"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
       summary: "Remove an Agent from Inventory"
       description: "Removes an Agent from Inventory."