Browse Source

SONAR-18741 Drop support for providing module keys in ws

tags/10.1.0.73491
Léo Geoffroy 1 year ago
parent
commit
328e5ce94d
18 changed files with 24 additions and 11 deletions
  1. 2
    1
      server/sonar-webserver-webapi/src/it/java/org/sonar/server/component/ws/ShowActionIT.java
  2. 1
    0
      server/sonar-webserver-webapi/src/it/java/org/sonar/server/component/ws/TreeActionIT.java
  3. 2
    1
      server/sonar-webserver-webapi/src/it/java/org/sonar/server/ui/ws/ComponentActionIT.java
  4. 2
    1
      server/sonar-webserver-webapi/src/main/java/org/sonar/server/ce/ws/ActivityAction.java
  5. 4
    2
      server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/AppAction.java
  6. 1
    0
      server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/ShowAction.java
  7. 1
    0
      server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/TreeAction.java
  8. 1
    0
      server/sonar-webserver-webapi/src/main/java/org/sonar/server/favorite/ws/AddAction.java
  9. 3
    1
      server/sonar-webserver-webapi/src/main/java/org/sonar/server/favorite/ws/RemoveAction.java
  10. 1
    0
      server/sonar-webserver-webapi/src/main/java/org/sonar/server/measure/ws/ComponentAction.java
  11. 3
    1
      server/sonar-webserver-webapi/src/main/java/org/sonar/server/setting/ws/ListDefinitionsAction.java
  12. 1
    0
      server/sonar-webserver-webapi/src/main/java/org/sonar/server/setting/ws/SetAction.java
  13. 1
    0
      server/sonar-webserver-webapi/src/main/java/org/sonar/server/setting/ws/ValuesAction.java
  14. 1
    0
      server/sonar-webserver-webapi/src/main/java/org/sonar/server/ui/ws/ComponentAction.java
  15. 0
    1
      sonar-ws/src/main/java/org/sonarqube/ws/client/components/SearchRequest.java
  16. 0
    1
      sonar-ws/src/main/java/org/sonarqube/ws/client/components/SuggestionsRequest.java
  17. 0
    1
      sonar-ws/src/main/java/org/sonarqube/ws/client/components/TreeRequest.java
  18. 0
    1
      sonar-ws/src/main/java/org/sonarqube/ws/client/measures/ComponentTreeRequest.java

+ 2
- 1
server/sonar-webserver-webapi/src/it/java/org/sonar/server/component/ws/ShowActionIT.java View 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);

+ 1
- 0
server/sonar-webserver-webapi/src/it/java/org/sonar/server/component/ws/TreeActionIT.java View 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"));

+ 2
- 1
server/sonar-webserver-webapi/src/it/java/org/sonar/server/ui/ws/ComponentActionIT.java View 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();

+ 2
- 1
server/sonar-webserver-webapi/src/main/java/org/sonar/server/ce/ws/ActivityAction.java View 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)

+ 4
- 2
server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/AppAction.java View 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);


+ 1
- 0
server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/ShowAction.java View 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);


+ 1
- 0
server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/TreeAction.java View 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)))

+ 1
- 0
server/sonar-webserver-webapi/src/main/java/org/sonar/server/favorite/ws/AddAction.java View 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"),

+ 3
- 1
server/sonar-webserver-webapi/src/main/java/org/sonar/server/favorite/ws/RemoveAction.java View 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);


+ 1
- 0
server/sonar-webserver-webapi/src/main/java/org/sonar/server/measure/ws/ComponentAction.java View 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."),

+ 3
- 1
server/sonar-webserver-webapi/src/main/java/org/sonar/server/setting/ws/ListDefinitionsAction.java View 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")

+ 1
- 0
server/sonar-webserver-webapi/src/main/java/org/sonar/server/setting/ws/SetAction.java View 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"))

+ 1
- 0
server/sonar-webserver-webapi/src/main/java/org/sonar/server/setting/ws/ValuesAction.java View 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)),

+ 1
- 0
server/sonar-webserver-webapi/src/main/java/org/sonar/server/ui/ws/ComponentAction.java View 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"),

+ 0
- 1
sonar-ws/src/main/java/org/sonarqube/ws/client/components/SearchRequest.java View 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>

+ 0
- 1
sonar-ws/src/main/java/org/sonarqube/ws/client/components/SuggestionsRequest.java View 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>

+ 0
- 1
sonar-ws/src/main/java/org/sonarqube/ws/client/components/TreeRequest.java View File

@@ -137,7 +137,6 @@ public class TreeRequest {
/**
* Possible values:
* <ul>
* <li>"BRC"</li>
* <li>"DIR"</li>
* <li>"FIL"</li>
* <li>"TRK"</li>

+ 0
- 1
sonar-ws/src/main/java/org/sonarqube/ws/client/measures/ComponentTreeRequest.java View File

@@ -215,7 +215,6 @@ public class ComponentTreeRequest {
/**
* Possible values:
* <ul>
* <li>"BRC"</li>
* <li>"DIR"</li>
* <li>"FIL"</li>
* <li>"TRK"</li>

Loading…
Cancel
Save