]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-18741 Drop support for providing module keys in ws
authorLéo Geoffroy <leo.geoffroy@sonarsource.com>
Wed, 3 May 2023 15:18:36 +0000 (17:18 +0200)
committersonartech <sonartech@sonarsource.com>
Wed, 3 May 2023 20:02:58 +0000 (20:02 +0000)
18 files changed:
server/sonar-webserver-webapi/src/it/java/org/sonar/server/component/ws/ShowActionIT.java
server/sonar-webserver-webapi/src/it/java/org/sonar/server/component/ws/TreeActionIT.java
server/sonar-webserver-webapi/src/it/java/org/sonar/server/ui/ws/ComponentActionIT.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/ce/ws/ActivityAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/AppAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/ShowAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/TreeAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/favorite/ws/AddAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/favorite/ws/RemoveAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/measure/ws/ComponentAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/setting/ws/ListDefinitionsAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/setting/ws/SetAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/setting/ws/ValuesAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/ui/ws/ComponentAction.java
sonar-ws/src/main/java/org/sonarqube/ws/client/components/SearchRequest.java
sonar-ws/src/main/java/org/sonarqube/ws/client/components/SuggestionsRequest.java
sonar-ws/src/main/java/org/sonarqube/ws/client/components/TreeRequest.java
sonar-ws/src/main/java/org/sonarqube/ws/client/measures/ComponentTreeRequest.java

index f8793a0ed7581e50db46cb45c1332dc5d50ff9cb..55e8fc573215795fd9f9da2f330d0bd7903f5dce 100644 (file)
@@ -78,7 +78,8 @@ public class ShowActionIT {
     assertThat(action.description()).isNotNull();
     assertThat(action.responseExample()).isNotNull();
     assertThat(action.changelog()).extracting(Change::getVersion, Change::getDescription).containsExactlyInAnyOrder(
-      tuple("7.6", "The use of module keys in parameter 'component' is deprecated"));
+      tuple("7.6", "The use of module keys in parameter 'component' is deprecated"),
+      tuple("10.1", "The use of module keys in parameter 'component' is removed"));
     assertThat(action.params()).extracting(WebService.Param::key).containsExactlyInAnyOrder("component", "branch", "pullRequest");
 
     WebService.Param component = action.param(PARAM_COMPONENT);
index 6b02526188a06c7d30c5317b021cf5fa226fef05..e353afcbe5f594ef9e3a918f5411c81772716fe9 100644 (file)
@@ -99,6 +99,7 @@ public class TreeActionIT {
     assertThat(action.description()).isNotNull();
     assertThat(action.responseExample()).isNotNull();
     assertThat(action.changelog()).extracting(Change::getVersion, Change::getDescription).containsExactlyInAnyOrder(
+      tuple("10.1", "The use of module keys in parameter 'component' is removed"),
       tuple("10.1", "The use of 'BRC' as value for parameter 'qualifiers' is removed"),
       tuple("7.6", "The use of 'BRC' as value for parameter 'qualifiers' is deprecated"),
       tuple("7.6", "The use of module keys in parameter 'component' is deprecated"));
index 469ec426a1dcc9c5a80bb694b3c0f3ece784782f..06ffe2da29930626dad6f253476b44883eb6f8c8 100644 (file)
@@ -749,7 +749,8 @@ public class ComponentActionIT {
       tuple("6.4", "The 'visibility' field is added"),
       tuple("7.3", "The 'almRepoUrl' and 'almId' fields are added"),
       tuple("7.6", "The use of module keys in parameter 'component' is deprecated"),
-      tuple("8.8", "Deprecated parameter 'componentKey' has been removed. Please use parameter 'component' instead"));
+      tuple("8.8", "Deprecated parameter 'componentKey' has been removed. Please use parameter 'component' instead"),
+      tuple("10.1", "The use of module keys in parameter 'component' is removed"));
 
     WebService.Param componentId = action.param(PARAM_COMPONENT);
     assertThat(componentId.isRequired()).isFalse();
index 1b6fa75b1b2fe2de726c05b6584f408ca1eea945..5eb7b96b74c3be6a76b6c744667371c899890592 100644 (file)
@@ -112,7 +112,8 @@ public class ActivityAction implements CeWsAction {
         new Change("7.1", "field \"pullRequest\" added"),
         new Change("7.6", format("The use of module keys in parameters '%s' is deprecated", TEXT_QUERY)),
         new Change("8.8", "field \"logs\" is dropped"),
-        new Change("10.0", "Remove deprecated field 'componentId'"))
+        new Change("10.0", "Remove deprecated field 'componentId'"),
+        new Change("10.1", String.format("The use of module keys in parameter '%s' is removed", PARAM_COMPONENT)))
       .setSince("5.2");
 
     action.createParam(PARAM_COMPONENT)
index 80ab01dd0deeb86cdb83c437f589dad9231f0386..b183208c47a335d09c04e64b16266ff981c836ac 100644 (file)
@@ -61,8 +61,10 @@ public class AppAction implements ComponentsWsAction {
         "Requires the following permission: 'Browse'.")
       .setResponseExample(getClass().getResource("app-example.json"))
       .setSince("4.4")
-      .setChangelog(new Change("9.6", "The fields 'subProject', 'subProjectName' were removed from the response."))
-      .setChangelog(new Change("7.6", String.format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)))
+      .setChangelog(
+        new Change("10.1", String.format("The use of module keys in parameter '%s' is removed", PARAM_COMPONENT)),
+        new Change("9.6", "The fields 'subProject', 'subProjectName' were removed from the response."),
+        new Change("7.6", String.format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)))
       .setInternal(true)
       .setHandler(this);
 
index 73adff9711282342814acc3336e03a7201f6817c..fcaee32e5f1e5bc79b74e0dabd11c9176c84dd68 100644 (file)
@@ -79,6 +79,7 @@ public class ShowAction implements ComponentsWsAction {
       .setResponseExample(getClass().getResource("show-example.json"))
       .setSince("5.4")
       .setChangelog(
+        new Change("10.1", String.format("The use of module keys in parameter '%s' is removed", PARAM_COMPONENT)),
         new Change("7.6", String.format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)))
       .setHandler(this);
 
index 5b8b1aa8343d31e9bcdbdfe8d3d449c8d6f6f596..827be3accba10cac97a39cb0ba621c6a621b0b73 100644 (file)
@@ -119,6 +119,7 @@ public class TreeAction implements ComponentsWsAction {
       .setSince("5.4")
       .setResponseExample(getClass().getResource("tree-example.json"))
       .setChangelog(
+        new Change("10.1", String.format("The use of module keys in parameter '%s' is removed", PARAM_COMPONENT)),
         new Change("10.1", String.format("The use of 'BRC' as value for parameter '%s' is removed", PARAM_QUALIFIERS)),
         new Change("7.6", String.format("The use of 'BRC' as value for parameter '%s' is deprecated", PARAM_QUALIFIERS)),
         new Change("7.6", String.format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)))
index eda655430ffe3da0627f817ae0d543271bb18d72..32f37d483699c2570f77f65ac6f70d869a669960 100644 (file)
@@ -69,6 +69,7 @@ public class AddAction implements FavoritesWsAction {
         "Requires authentication and the following permission: 'Browse' on the project of the specified component.")
       .setSince("6.3")
       .setChangelog(
+        new Change("10.1", String.format("The use of module keys in parameter '%s' is removed", PARAM_COMPONENT)),
         new Change("8.4", "It's no longer possible to set a file as favorite"),
         new Change("7.7", "It's no longer possible to have more than 100 favorites by qualifier"),
         new Change("7.7", "It's no longer possible to set a directory as favorite"),
index a1a9cd4d6e0edbf8a586a5a7cf3b66f4c6b333a7..0d8ddb707e8f5f6d6591ebfdbcb5491f78bf02c5 100644 (file)
@@ -53,7 +53,9 @@ public class RemoveAction implements FavoritesWsAction {
       .setDescription("Remove a component (project, portfolio, application etc.) as favorite for the authenticated user.<br>" +
         "Requires authentication.")
       .setSince("6.3")
-      .setChangelog(new Change("7.6", String.format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)))
+      .setChangelog(
+        new Change("10.1", String.format("The use of module keys in parameter '%s' is removed", PARAM_COMPONENT)),
+        new Change("7.6", String.format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)))
       .setPost(true)
       .setHandler(this);
 
index 8f325fd65539b335298e1b8b5694acf0a9cd0b3f..87eb8984c714ecd0977285004e0a5737cc6227d5 100644 (file)
@@ -96,6 +96,7 @@ public class ComponentAction implements MeasuresWsAction {
       .setResponseExample(getClass().getResource("component-example.json"))
       .setSince("5.4")
       .setChangelog(
+        new Change("10.1", String.format("The use of module keys in parameter '%s' is removed", PARAM_COMPONENT)),
         new Change("10.0", format("The use of the following metrics in 'metricKeys' parameter is not deprecated anymore: %s",
           MeasuresWsModule.getDeprecatedMetrics())),
         new Change("10.0", "the response field periods under measures field is removed."),
index 7c3dfe2cba1c648a95c42c034960c6ad65b3dfdd..c14b2b1391c91f4b9f035b9de7fc65adbadc094b 100644 (file)
@@ -77,7 +77,9 @@ public class ListDefinitionsAction implements SettingsWsAction {
         "</ul>")
       .setResponseExample(getClass().getResource("list_definitions-example.json"))
       .setSince("6.3")
-      .setChangelog(new Change("7.6", String.format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)))
+      .setChangelog(
+        new Change("10.1", String.format("The use of module keys in parameter '%s' is removed", PARAM_COMPONENT)),
+        new Change("7.6", String.format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)))
       .setHandler(this);
     action.createParam(PARAM_COMPONENT)
       .setDescription("Component key")
index 5332a5280e321014f95601ad64c18398ab63a712..92884434b95b9e1f5791a27be5f8bd7e35251c6c 100644 (file)
@@ -103,6 +103,7 @@ public class SetAction implements SettingsWsAction {
         PARAM_VALUE, PARAM_VALUES)
       .setSince("6.1")
       .setChangelog(
+        new Change("10.1", String.format("The use of module keys in parameter '%s' is removed", PARAM_COMPONENT)),
         new Change("8.8", "Deprecated parameter 'componentKey' has been removed"),
         new Change("7.6", String.format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)),
         new Change("7.1", "The settings defined in conf/sonar.properties are read-only and can't be changed"))
index deb01610b6ec8f245490121d9c76908148ec047a..7157264adedb5c9b15a59d67df33b986ed77b71c 100644 (file)
@@ -103,6 +103,7 @@ public class ValuesAction implements SettingsWsAction {
       .setResponseExample(getClass().getResource("values-example.json"))
       .setSince("6.3")
       .setChangelog(
+        new Change("10.1", String.format("The use of module keys in parameter '%s' is removed", PARAM_COMPONENT)),
         new Change("9.1", "The secured settings values are no longer returned. Secured settings keys that have a value " +
           "are now returned in setSecuredSettings array."),
         new Change("7.6", String.format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)),
index 58e63b6f85897852ee2949529a8032156f5e19a9..3a458ad258817b50206d77b0f6a6038e23a3d551 100644 (file)
@@ -121,6 +121,7 @@ public class ComponentAction implements NavigationWsAction {
       .setResponseExample(getClass().getResource("component-example.json"))
       .setSince("5.2")
       .setChangelog(
+        new Change("10.1", String.format("The use of module keys in parameter '%s' is removed", PARAM_COMPONENT)),
         new Change("8.8", "Deprecated parameter 'componentKey' has been removed. Please use parameter 'component' instead"),
         new Change("7.6", format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)),
         new Change("7.3", "The 'almRepoUrl' and 'almId' fields are added"),
index 5171c19ea76c6af1d52bc4af9992065f2f3bfa2c..2b221c62864915980cc32fa9145db9e40eec2525 100644 (file)
@@ -89,7 +89,6 @@ public class SearchRequest {
    * This is a mandatory parameter.
    * Possible values:
    * <ul>
-   *   <li>"BRC"</li>
    *   <li>"DIR"</li>
    *   <li>"FIL"</li>
    *   <li>"TRK"</li>
index 3b38f80ebab3aaa73de5a2075445eccd41b64f8e..07b4594d7106c211aefbd89d70ef79dde6b7b823 100644 (file)
@@ -42,7 +42,6 @@ public class SuggestionsRequest {
    *   <li>"SVW"</li>
    *   <li>"APP"</li>
    *   <li>"TRK"</li>
-   *   <li>"BRC"</li>
    *   <li>"FIL"</li>
    *   <li>"UTS"</li>
    * </ul>
index a796a094775c3aa12e2398607f6be95dc2a4ff87..1473e48559e01ccd9d4b05963f3c149d1c670723 100644 (file)
@@ -137,7 +137,6 @@ public class TreeRequest {
   /**
    * Possible values:
    * <ul>
-   *   <li>"BRC"</li>
    *   <li>"DIR"</li>
    *   <li>"FIL"</li>
    *   <li>"TRK"</li>
index 7e3157d6958d51b21564f718bd9c5fa1b90872b0..745988405b18669a08c926fac1cde6277c7714cd 100644 (file)
@@ -215,7 +215,6 @@ public class ComponentTreeRequest {
   /**
    * Possible values:
    * <ul>
-   *   <li>"BRC"</li>
    *   <li>"DIR"</li>
    *   <li>"FIL"</li>
    *   <li>"TRK"</li>