From 2729562ca18eb3bc294ade1c7e4995c23d46ca32 Mon Sep 17 00:00:00 2001 From: Teryk Bellahsene Date: Mon, 22 May 2017 09:49:37 +0200 Subject: [PATCH] SONAR-9275 WS api/issues/delete_comment create changelog of API changes --- .../org/sonar/server/issue/ws/DeleteCommentAction.java | 10 +++++++--- .../sonar/server/issue/ws/delete_comment-example.json | 1 - 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.java index 613a097e063..97d0b0d0884 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.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; @@ -60,10 +61,13 @@ public class DeleteCommentAction implements IssuesWsAction { public void define(WebService.NewController context) { WebService.NewAction action = context.createAction(ACTION_DELETE_COMMENT) .setDescription("Delete a comment.
" + - "Requires authentication and the following permission: 'Browse' on the project of the specified issue.
" + - "Since 6.3, the response contains the issue with all details, not the removed comment.
" + - "Since 6.3, 'key' parameter has been renamed to %s", PARAM_COMMENT) + "Requires authentication and the following permission: 'Browse' on the project of the specified issue.") .setSince("3.6") + .setChangelog( + new Change("6.5", "the response field components.uuid is deprecated. Use components.key instead."), + new Change("6.5", "the database ids of the components are removed from the response"), + new Change("6.3", "the response returns the issue with all its details"), + new Change("6.3", "the 'key' parameter is renamed 'comment'")) .setHandler(this) .setResponseExample(Resources.getResource(this.getClass(), "delete_comment-example.json")) .setPost(true); diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/delete_comment-example.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/delete_comment-example.json index 7cab6160070..412ea524298 100644 --- a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/delete_comment-example.json +++ b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/delete_comment-example.json @@ -4,7 +4,6 @@ "rule": "squid:S2301", "severity": "MAJOR", "component": "org.sonarsource.sonarlint.intellij:sonarlint-intellij:src/main/java/org/sonarlint/intellij/core/ServerIssueUpdater.java", - "componentId": 87163, "project": "org.sonarsource.sonarlint.intellij:sonarlint-intellij", "line": 78, "textRange": { -- 2.39.5