From ccf7c5c1cd340592c3c1af5577caf0a9db92fb7b Mon Sep 17 00:00:00 2001 From: Duarte Meneses Date: Wed, 19 Apr 2023 16:32:00 -0500 Subject: [PATCH] SONAR-19050 Add characteristic to response of issue web services --- .../main/java/org/sonar/server/issue/ws/AddCommentAction.java | 1 + .../src/main/java/org/sonar/server/issue/ws/AssignAction.java | 1 + .../main/java/org/sonar/server/issue/ws/BasePullAction.java | 4 ++++ .../java/org/sonar/server/issue/ws/DeleteCommentAction.java | 1 + .../java/org/sonar/server/issue/ws/DoTransitionAction.java | 1 + .../java/org/sonar/server/issue/ws/EditCommentAction.java | 1 + .../java/org/sonar/server/issue/ws/SetSeverityAction.java | 1 + .../main/java/org/sonar/server/issue/ws/SetTagsAction.java | 1 + .../main/java/org/sonar/server/issue/ws/SetTypeAction.java | 1 + .../org/sonar/server/issue/ws/add_comment-example.json | 3 ++- .../resources/org/sonar/server/issue/ws/assign-example.json | 3 ++- .../org/sonar/server/issue/ws/delete_comment-example.json | 3 ++- .../org/sonar/server/issue/ws/do_transition-example.json | 3 ++- .../org/sonar/server/issue/ws/edit_comment-example.json | 3 ++- .../resources/org/sonar/server/issue/ws/search-example.json | 3 ++- .../org/sonar/server/issue/ws/set_severity-example.json | 3 ++- .../resources/org/sonar/server/issue/ws/set_tags-example.json | 3 ++- .../resources/org/sonar/server/issue/ws/set_type-example.json | 3 ++- 18 files changed, 30 insertions(+), 9 deletions(-) diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/AddCommentAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/AddCommentAction.java index 18d576a1032..ec6069bf65b 100644 --- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/AddCommentAction.java +++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/AddCommentAction.java @@ -72,6 +72,7 @@ public class AddCommentAction implements IssuesWsAction { "Requires authentication and the following permission: 'Browse' on the project of the specified issue.") .setSince("3.6") .setChangelog( + new Change("10.1", "Field 'characteristic' added to issues in the response"), new Change("9.6", "Response field 'ruleDescriptionContextKey' added"), new Change("8.8", "The response field components.uuid is removed"), new Change("6.3", "the response returns the issue with all its details"), diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/AssignAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/AssignAction.java index 9e1c9ca3231..39fb37ff5f4 100644 --- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/AssignAction.java +++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/AssignAction.java @@ -75,6 +75,7 @@ public class AssignAction implements IssuesWsAction { .setDescription("Assign/Unassign an issue. Requires authentication and Browse permission on project") .setSince("3.6") .setChangelog( + new Change("10.1", "Field 'characteristic' added to issues in the response"), new Change("9.6", "Response field 'ruleDescriptionContextKey' added"), new Change("8.8", "The response field components.uuid is removed"), new Change("6.5", "the database ids of the components are removed from the response"), diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/BasePullAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/BasePullAction.java index 920366f0d9d..f506e27951a 100644 --- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/BasePullAction.java +++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/BasePullAction.java @@ -26,6 +26,7 @@ import java.util.List; import java.util.Set; import java.util.function.Consumer; import javax.annotation.Nullable; +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; @@ -84,6 +85,9 @@ public abstract class BasePullAction implements IssuesWsAction { .createAction(actionName) .setHandler(this) .setInternal(true) + .setChangelog( + new Change("10.1", "Field 'characteristic' added to issues in the response") + ) .setResponseExample(getClass().getResource(resourceExample)) .setDescription(format("This endpoint fetches and returns all (unless filtered by optional params) the %s for a given branch. " + "The %s returned are not paginated, so the response size can be big. Requires project 'Browse' permission.", issueType, issueType)) diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.java index a6efef345bf..62c3a662755 100644 --- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.java +++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.java @@ -60,6 +60,7 @@ public class DeleteCommentAction implements IssuesWsAction { "Requires authentication and the following permission: 'Browse' on the project of the specified issue.") .setSince("3.6") .setChangelog( + new Change("10.1", "Field 'characteristic' added to issues in the response"), new Change("9.6", "Response field 'ruleDescriptionContextKey' added"), new Change("8.8", "The response field components.uuid is removed"), new Change("6.5", "the response field components.uuid is deprecated. Use components.key instead."), diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/DoTransitionAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/DoTransitionAction.java index f9db25c4734..278dbba2f1a 100644 --- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/DoTransitionAction.java +++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/DoTransitionAction.java @@ -82,6 +82,7 @@ public class DoTransitionAction implements IssuesWsAction { "The transitions involving security hotspots require the permission 'Administer Security Hotspot'.") .setSince("3.6") .setChangelog( + new Change("10.1", "Field 'characteristic' added to issues in the response"), new Change("9.6", "Response field 'ruleDescriptionContextKey' added"), new Change("8.8", "The response field components.uuid is removed"), new Change("8.1", format("transitions '%s' and '%s' are no more supported", SET_AS_IN_REVIEW, OPEN_AS_VULNERABILITY)), diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java index b5b7fe2df24..29f0404aee1 100644 --- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java +++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java @@ -66,6 +66,7 @@ public class EditCommentAction implements IssuesWsAction { "Requires authentication and the following permission: 'Browse' on the project of the specified issue.") .setSince("3.6") .setChangelog( + new Change("10.1", "Field 'characteristic' added to issues in the response"), new Change("9.6", "Response field 'ruleDescriptionContextKey' added"), new Change("8.8", "The response field components.uuid is removed"), new Change("6.3", "the response returns the issue with all its details"), diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetSeverityAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetSeverityAction.java index a00dd2afa7d..3149d5db3c9 100644 --- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetSeverityAction.java +++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetSeverityAction.java @@ -79,6 +79,7 @@ public class SetSeverityAction implements IssuesWsAction { "") .setSince("3.6") .setChangelog( + new Change("10.1", "Field 'characteristic' added to issues in the response"), new Change("9.6", "Response field 'ruleDescriptionContextKey' added"), new Change("8.8", "The response field components.uuid is removed"), new Change("6.5", "the database ids of the components are removed from the response"), diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetTagsAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetTagsAction.java index 7bbc6824062..da921bc570d 100644 --- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetTagsAction.java +++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetTagsAction.java @@ -74,6 +74,7 @@ public class SetTagsAction implements IssuesWsAction { .setDescription("Set tags on an issue.
" + "Requires authentication and Browse permission on project") .setChangelog( + new Change("10.1", "Field 'characteristic' added to issues in the response"), new Change("9.6", "Response field 'ruleDescriptionContextKey' added"), new Change("8.8", "The response field components.uuid is removed"), new Change("6.5", "the database ids of the components are removed from the response"), diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetTypeAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetTypeAction.java index 6807f29186d..873f53d2aa9 100644 --- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetTypeAction.java +++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SetTypeAction.java @@ -83,6 +83,7 @@ public class SetTypeAction implements IssuesWsAction { "") .setSince("5.5") .setChangelog( + new Change("10.1", "Field 'characteristic' added to issues in the response"), new Change("9.6", "Response field 'ruleDescriptionContextKey' added"), new Change("8.8", "The response field components.uuid is removed"), new Change("6.5", "the database ids of the components are removed from the response"), diff --git a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/add_comment-example.json b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/add_comment-example.json index 38de0633acf..aef1969c677 100644 --- a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/add_comment-example.json +++ b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/add_comment-example.json @@ -48,7 +48,8 @@ "creationDate": "2016-11-25T13:50:24+0100", "updateDate": "2017-01-09T13:51:12+0100", "type": "CODE_SMELL", - "ruleDescriptionContextKey": "spring" + "ruleDescriptionContextKey": "spring", + "characteristic": "CLEAR" }, "components": [ { diff --git a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/assign-example.json b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/assign-example.json index f591d112dbb..68cdeb1f1ce 100644 --- a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/assign-example.json +++ b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/assign-example.json @@ -48,7 +48,8 @@ "creationDate": "2016-11-25T13:50:24+0100", "updateDate": "2017-01-09T13:51:12+0100", "type": "CODE_SMELL", - "ruleDescriptionContextKey": "spring" + "ruleDescriptionContextKey": "spring", + "characteristic": "CLEAR" }, "components": [ { diff --git a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/delete_comment-example.json b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/delete_comment-example.json index f591d112dbb..68cdeb1f1ce 100644 --- a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/delete_comment-example.json +++ b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/delete_comment-example.json @@ -48,7 +48,8 @@ "creationDate": "2016-11-25T13:50:24+0100", "updateDate": "2017-01-09T13:51:12+0100", "type": "CODE_SMELL", - "ruleDescriptionContextKey": "spring" + "ruleDescriptionContextKey": "spring", + "characteristic": "CLEAR" }, "components": [ { diff --git a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/do_transition-example.json b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/do_transition-example.json index f591d112dbb..68cdeb1f1ce 100644 --- a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/do_transition-example.json +++ b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/do_transition-example.json @@ -48,7 +48,8 @@ "creationDate": "2016-11-25T13:50:24+0100", "updateDate": "2017-01-09T13:51:12+0100", "type": "CODE_SMELL", - "ruleDescriptionContextKey": "spring" + "ruleDescriptionContextKey": "spring", + "characteristic": "CLEAR" }, "components": [ { diff --git a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/edit_comment-example.json b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/edit_comment-example.json index f591d112dbb..68cdeb1f1ce 100644 --- a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/edit_comment-example.json +++ b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/edit_comment-example.json @@ -48,7 +48,8 @@ "creationDate": "2016-11-25T13:50:24+0100", "updateDate": "2017-01-09T13:51:12+0100", "type": "CODE_SMELL", - "ruleDescriptionContextKey": "spring" + "ruleDescriptionContextKey": "spring", + "characteristic": "CLEAR" }, "components": [ { diff --git a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/search-example.json b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/search-example.json index 3e90745a062..d3d230fa52c 100644 --- a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/search-example.json +++ b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/search-example.json @@ -93,7 +93,8 @@ } ], "quickFixAvailable": false, - "ruleDescriptionContextKey": "spring" + "ruleDescriptionContextKey": "spring", + "characteristic": "CLEAR" } ], "components": [ diff --git a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_severity-example.json b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_severity-example.json index f591d112dbb..68cdeb1f1ce 100644 --- a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_severity-example.json +++ b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_severity-example.json @@ -48,7 +48,8 @@ "creationDate": "2016-11-25T13:50:24+0100", "updateDate": "2017-01-09T13:51:12+0100", "type": "CODE_SMELL", - "ruleDescriptionContextKey": "spring" + "ruleDescriptionContextKey": "spring", + "characteristic": "CLEAR" }, "components": [ { diff --git a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_tags-example.json b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_tags-example.json index d690eb9b06a..5ad480ff14a 100644 --- a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_tags-example.json +++ b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_tags-example.json @@ -48,7 +48,8 @@ "creationDate": "2016-11-25T13:50:24+0100", "updateDate": "2017-01-09T13:51:12+0100", "type": "CODE_SMELL", - "ruleDescriptionContextKey": "spring" + "ruleDescriptionContextKey": "spring", + "characteristic": "CLEAR" }, "components": [ { diff --git a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_type-example.json b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_type-example.json index f591d112dbb..68cdeb1f1ce 100644 --- a/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_type-example.json +++ b/server/sonar-webserver-webapi/src/main/resources/org/sonar/server/issue/ws/set_type-example.json @@ -48,7 +48,8 @@ "creationDate": "2016-11-25T13:50:24+0100", "updateDate": "2017-01-09T13:51:12+0100", "type": "CODE_SMELL", - "ruleDescriptionContextKey": "spring" + "ruleDescriptionContextKey": "spring", + "characteristic": "CLEAR" }, "components": [ { -- 2.39.5