]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-13848 remove deprecated parameter 'componentKey' from api/navigation/component
authorMichal Duda <michal.duda@sonarsource.com>
Wed, 24 Feb 2021 15:21:15 +0000 (16:21 +0100)
committersonartech <sonartech@sonarsource.com>
Fri, 26 Feb 2021 20:07:40 +0000 (20:07 +0000)
server/sonar-webserver-webapi/src/main/java/org/sonar/server/ui/ws/ComponentAction.java
server/sonar-webserver-webapi/src/test/java/org/sonar/server/ui/ws/ComponentActionTest.java

index 2e011e8834135b431992e79e94e97a3f997ff9fa..ab048d254845f986158ce28100f99930d87876f7 100644 (file)
@@ -120,13 +120,13 @@ public class ComponentAction implements NavigationWsAction {
       .setResponseExample(getClass().getResource("component-example.json"))
       .setSince("5.2")
       .setChangelog(
+        new Change("8.8", "Deprecated parameter 'componentKey' has been removed. Please use parameter 'component' instead"),
         new Change("7.6", String.format("The use of module keys in parameter '%s' is deprecated", PARAM_COMPONENT)),
         new Change("7.3", "The 'almRepoUrl' and 'almId' fields are added"),
         new Change("6.4", "The 'visibility' field is added"));
 
     action.createParam(PARAM_COMPONENT)
       .setDescription("A component key.")
-      .setDeprecatedKey("componentKey", "6.4")
       .setExampleValue(KEY_PROJECT_EXAMPLE_001);
 
     action
index 9eb1231c4f488866428682e21bc38fc97321eca2..4ea440392d466b61b6a7b86a8cf48406ec4c10ac 100644 (file)
@@ -172,7 +172,7 @@ public class ComponentActionTest {
     init();
 
     String json = ws.newRequest()
-      .setParam("componentKey", project.getKey())
+      .setParam("component", project.getKey())
       .setParam("branch", branch.getBranch())
       .execute()
       .getInput();
@@ -229,7 +229,7 @@ public class ComponentActionTest {
       .setName("Main.xoo"));
 
     String json = ws.newRequest()
-      .setParam("componentKey", fileDto.getKey())
+      .setParam("component", fileDto.getKey())
       .setParam("branch", branch.getBranch())
       .execute()
       .getInput();
@@ -309,7 +309,7 @@ public class ComponentActionTest {
     init();
 
     String json = ws.newRequest()
-      .setParam("componentKey", project.getKey())
+      .setParam("component", project.getKey())
       .setParam("branch", branch.getKey())
       .execute()
       .getInput();
@@ -651,14 +651,13 @@ public class ComponentActionTest {
     assertThat(action.changelog()).extracting(Change::getVersion, Change::getDescription).containsExactlyInAnyOrder(
       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("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"));
 
     WebService.Param componentId = action.param(PARAM_COMPONENT);
     assertThat(componentId.isRequired()).isFalse();
     assertThat(componentId.description()).isNotNull();
     assertThat(componentId.exampleValue()).isNotNull();
-    assertThat(componentId.deprecatedKey()).isEqualTo("componentKey");
-    assertThat(componentId.deprecatedKeySince()).isEqualTo("6.4");
   }
 
   @Test(expected = BadRequestException.class)
@@ -709,7 +708,7 @@ public class ComponentActionTest {
   }
 
   private String execute(String componentKey) {
-    return ws.newRequest().setParam("componentKey", componentKey).execute().getInput();
+    return ws.newRequest().setParam("component", componentKey).execute().getInput();
   }
 
   private void verify(String json, String jsonFile) {