]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-18955 fix the description of qualitygates endpoints
authorMatteo Mara <matteo.mara@sonarsource.com>
Mon, 3 Apr 2023 12:55:14 +0000 (14:55 +0200)
committersonartech <sonartech@sonarsource.com>
Mon, 3 Apr 2023 20:02:59 +0000 (20:02 +0000)
server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/CreateConditionAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/DestroyAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/qualitygate/ws/SetAsDefaultAction.java

index c33aff75b4f7acd5bfdd29926b7edf5f2975ce3e..aa5bad95c4d23a643a0173e80972e3c99139d574 100644 (file)
@@ -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(
index e07e4426100713a77df78cbdfe324ff7c9abe044..58122fc08c80b7ad72ac721b36527c4068f97958 100644 (file)
@@ -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);
index fc27433952b37c07e04609d7288fc288005e9279..ba7b622e19d6d219c9e9777dab144a27ed3492af 100644 (file)
@@ -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."),