SONAR-9277 WS api/issues/edit_comment replace part of description with changelog

diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java
index d69c349c144c3ce88b27fa2c14b27b13349f3bb5..f895b12dcad0dbe493aaba2b69fd5a95c9f6339d 100644 (file)
--- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java
@@ -24,6 +24,7 @@ import java.util.Objects;
 import java.util.function.Consumer;
 import java.util.function.Function;
 import java.util.stream.Stream;
+import org.sonar.api.server.ws.Change;
 import org.sonar.api.server.ws.Request;
 import org.sonar.api.server.ws.Response;
 import org.sonar.api.server.ws.WebService;
@@ -66,10 +67,12 @@ public class EditCommentAction implements IssuesWsAction {
   public void define(WebService.NewController context) {
     WebService.NewAction action = context.createAction(ACTION_EDIT_COMMENT)
       .setDescription("Edit a comment.<br/>" +
-        "Requires authentication and the following permission: 'Browse' on the project of the specified issue.<br/>" +
-        "Since 6.3, the response contains the issue with all details, not only the edited comment.<br/>" +
-        "Since 6.3, 'key' parameter has been renamed %s", PARAM_COMMENT)
+        "Requires authentication and the following permission: 'Browse' on the project of the specified issue.")
       .setSince("3.6")
+      .setChangelog(
+        new Change("6.3", "the response returns the issue with all its details"),
+        new Change("6.3", format("the 'key' parameter has been renamed %s", PARAM_COMMENT))
+      )
       .setHandler(this)
       .setResponseExample(Resources.getResource(this.getClass(), "edit_comment-example.json"))
       .setPost(true);