From: Matteo Mara <matteo.mara@sonarsource.com>
Date: Mon, 3 Apr 2023 12:55:14 +0000 (+0200)
Subject: SONAR-18955 fix the description of qualitygates endpoints
X-Git-Tag: 10.1.0.73491~527
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=dce81ae3d053265749704f714112d0b6ffb8956a;p=sonarqube.git

SONAR-18955 fix the description of qualitygates endpoints
---

diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/CreateConditionAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/CreateConditionAction.java
index c33aff75b4f..aa5bad95c4d 100644
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/CreateConditionAction.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/CreateConditionAction.java
@@ -55,7 +55,7 @@ public class CreateConditionAction implements QualityGatesWsAction {
     WebService.NewAction createCondition = controller.createAction(ACTION_CREATE_CONDITION)
       .setPost(true)
       .setDescription("Add a new condition to a quality gate.<br>" +
-        "Either 'gateId' or 'gateName' must be provided. Requires the 'Administer Quality Gates' permission.")
+        "Parameter 'gateName' must be provided. Requires the 'Administer Quality Gates' permission.")
       .setSince("4.3")
       .setResponseExample(getClass().getResource("create-condition-example.json"))
       .setChangelog(
diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/DestroyAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/DestroyAction.java
index e07e4426100..58122fc08c8 100644
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/DestroyAction.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/DestroyAction.java
@@ -47,11 +47,11 @@ public class DestroyAction implements QualityGatesWsAction {
   public void define(WebService.NewController controller) {
     WebService.NewAction action = controller.createAction("destroy")
       .setDescription("Delete a Quality Gate.<br>" +
-        "Either 'id' or 'name' must be specified. Requires the 'Administer Quality Gates' permission.")
+        "Parameter 'name' must be specified. Requires the 'Administer Quality Gates' permission.")
       .setSince("4.3")
       .setPost(true)
       .setChangelog(
-        new Change("10.0", "Parameter 'name' is removed. Use 'name' instead."),
+        new Change("10.0", "Parameter 'id' is removed. Use 'name' instead."),
         new Change("8.4", "Parameter 'name' added"),
         new Change("8.4", "Parameter 'id' is deprecated. Format changes from integer to string. Use 'name' instead."))
       .setHandler(this);
diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/SetAsDefaultAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/SetAsDefaultAction.java
index fc27433952b..ba7b622e19d 100644
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/SetAsDefaultAction.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/SetAsDefaultAction.java
@@ -50,7 +50,7 @@ public class SetAsDefaultAction implements QualityGatesWsAction {
   public void define(WebService.NewController controller) {
     WebService.NewAction action = controller.createAction("set_as_default")
       .setDescription("Set a quality gate as the default quality gate.<br>" +
-        "Either 'id' or 'name' must be specified. Requires the 'Administer Quality Gates' permission.")
+        "Parameter 'name' must be specified. Requires the 'Administer Quality Gates' permission.")
       .setSince("4.3")
       .setChangelog(
         new Change("10.0", "Parameter 'id' is removed. Use 'name' instead."),