SONAR-14311 Make it explicit that /api/issues/bulk_change only sets comments on issue...

diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/BulkChangeAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/BulkChangeAction.java
index 93202845f125f6e804d74a257ceadec7af1e09ec..4f77626fa40e7913f5a766386a2ddba58783179b 100644 (file)
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/BulkChangeAction.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/BulkChangeAction.java
@@ -187,7 +187,8 @@ public class BulkChangeAction implements IssuesWsAction {
       .setExampleValue("security,java8")
       .setDeprecatedKey("remove_tags.tags", "6.2");
     action.createParam(PARAM_COMMENT)
-      .setDescription("To add a comment to a list of issues")
+      .setDescription("Add a comment. "
+        + "The comment will only be added to issues that are affected either by a change of type or a change of severity as a result of the same WS call.")
       .setExampleValue("Here is my comment");
     action.createParam(PARAM_SEND_NOTIFICATIONS)
       .setSince("4.0")