]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-21114 deprecate migrated Users api v1 endpoints
authorAurelien Poscia <aurelien.poscia@sonarsource.com>
Tue, 16 Jan 2024 13:32:47 +0000 (14:32 +0100)
committersonartech <sonartech@sonarsource.com>
Wed, 17 Jan 2024 20:02:43 +0000 (20:02 +0000)
server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/AnonymizeAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/CreateAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/DeactivateAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/GroupsAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/SearchAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/UpdateAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/UpdateIdentityProviderAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/UpdateLoginAction.java

index 37ec13723afcac4db65eebb5757b006e848571bc..7ad72d64354fa4aa28e14f361e9430cb90f8fa8e 100644 (file)
@@ -19,6 +19,7 @@
  */
 package org.sonar.server.user.ws;
 
+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;
@@ -50,7 +51,9 @@ public class AnonymizeAction implements UsersWsAction {
       .setDescription("Anonymize a deactivated user. Requires Administer System permission")
       .setSince("9.7")
       .setPost(true)
-      .setHandler(this);
+      .setHandler(this)
+      .setDeprecatedSince("10.4")
+      .setChangelog(new Change("10.4", "Deprecated. Use DELETE api/v2/users-management/users/{id}?anonymize=true instead"));
 
     action.createParam(PARAM_LOGIN)
       .setDescription("User login")
index f3de3c37b4db37727416d71be4b51a98215d8c5e..14dea22273184e071cc51de1c56f2fd159955558 100644 (file)
@@ -77,7 +77,9 @@ public class CreateAction implements UsersWsAction {
         new Change("6.3", "The 'infos' message is no more returned when a user is reactivated"))
       .setPost(true)
       .setResponseExample(getClass().getResource("create-example.json"))
-      .setHandler(this);
+      .setHandler(this)
+      .setDeprecatedSince("10.4")
+      .setChangelog(new Change("10.4", "Deprecated. Use POST api/v2/users-management/users instead"));;
 
     action.createParam(PARAM_LOGIN)
       .setRequired(true)
index 5359305116ff2f89b5edcb924b06324309d670ef..74185e224a71d501f21f83961acb51a7c2852394 100644 (file)
@@ -21,6 +21,7 @@ package org.sonar.server.user.ws;
 
 import java.util.HashSet;
 import java.util.Set;
+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,7 +61,9 @@ public class DeactivateAction implements UsersWsAction {
       .setSince("3.7")
       .setPost(true)
       .setResponseExample(getClass().getResource("deactivate-example.json"))
-      .setHandler(this);
+      .setHandler(this)
+      .setDeprecatedSince("10.4")
+      .setChangelog(new Change("10.4", "Deprecated. Use DELETE api/v2/users-management/users/{id} instead"));
 
     action.createParam(PARAM_LOGIN)
       .setDescription("User login")
index 2a20c80ffe0d21cdf31e11bb67f03a6358370999..c645eba2821cb4e810255830c323a09148cb911f 100644 (file)
@@ -77,9 +77,12 @@ public class GroupsAction implements UsersWsAction {
       .addSelectionModeParam()
       .addSearchQuery("users", "group names")
       .addPagingParams(25)
-      .setChangelog(new Change("6.4", "Paging response fields moved to a Paging object"),
+      .setChangelog(
+        new Change("10.4", "Deprecated. Use GET api/v2/authorizations/groups-memberships?userId={} instead"),
+        new Change("6.4", "Paging response fields moved to a Paging object"),
         new Change("6.4", "'default' response field has been added"))
-      .setSince("5.2");
+      .setSince("5.2")
+      .setDeprecatedSince("10.4");
 
     action.createParam(PARAM_LOGIN)
       .setDescription("A user login")
index 16f34642c752ae4590183e6146243f274d4a23ff..637a3d791df51e656febb455648435d18a9fa2df 100644 (file)
@@ -80,6 +80,7 @@ public class SearchAction implements UsersWsAction {
         "Field 'lastConnectionDate' is only updated every hour, so it may not be accurate, for instance when a user authenticates many times in less than one hour.")
       .setSince("3.6")
       .setChangelog(
+        new Change("10.4", "Deprecated. Use GET api/v2/users-management/users instead"),
         new Change("10.3", "New optional parameters " + EXTERNAL_IDENTITY + " to find a user by its IdP login"),
         new Change("10.1", "New optional parameters " + SONAR_LINT_LAST_CONNECTION_DATE_FROM +
           " and " + SONAR_LINT_LAST_CONNECTION_DATE_TO + " to filter users by SonarLint last connection date. Only available with Administer System permission."),
@@ -96,7 +97,8 @@ public class SearchAction implements UsersWsAction {
         new Change("6.4", "Avatar has been added to the response"),
         new Change("6.4", "Email is only returned when user has Administer System permission"))
       .setHandler(this)
-      .setResponseExample(getClass().getResource("search-example.json"));
+      .setResponseExample(getClass().getResource("search-example.json"))
+      .setDeprecatedSince("10.4");
 
     action.addPagingParams(50, SearchOptions.MAX_PAGE_SIZE);
 
index 18a5327c42b06fc7c3884d9d38dd05ba81192615..10379067f277d08feafebac11f50d5eba599dcc7 100644 (file)
@@ -80,10 +80,12 @@ public class UpdateAction implements UsersWsAction {
         "Requires Administer System permission")
       .setSince("3.7")
       .setChangelog(
+        new Change("10.4", "Deprecated. Use PATCH api/v2/users-management/users/{id} instead"),
         new Change("5.2", "User's password can only be changed using the 'change_password' action."))
       .setPost(true)
       .setHandler(this)
-      .setResponseExample(getClass().getResource("update-example.json"));
+      .setResponseExample(getClass().getResource("update-example.json"))
+      .setDeprecatedSince("10.4");
 
     action.createParam(PARAM_LOGIN)
       .setRequired(true)
index cad8de36c437e7b8951fb7a7ada5a5158222f90f..a86c3e5a91ee7f9491f9bc1b5b24e2b1647c2e1e 100644 (file)
@@ -78,7 +78,9 @@ public class UpdateIdentityProviderAction implements UsersWsAction {
       .setSince("8.7")
       .setInternal(false)
       .setPost(true)
-      .setHandler(this);
+      .setHandler(this)
+      .setDeprecatedSince("10.4")
+      .setChangelog(new Change("10.4", "Deprecated. Use PATCH api/v2/users-management/users/{id} instead"));
 
     action.createParam(PARAM_LOGIN)
       .setDescription("User login")
index 03fe245c440104b96763d2d27a0138cc04d8ba4b..006f97e6e21498175a65f0917eaa43330eef6232 100644 (file)
  */
 package org.sonar.server.user.ws;
 
+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;
 import org.sonar.db.DbClient;
 import org.sonar.db.DbSession;
 import org.sonar.db.user.UserDto;
-import org.sonar.server.exceptions.NotFoundException;
 import org.sonar.server.common.management.ManagedInstanceChecker;
+import org.sonar.server.exceptions.NotFoundException;
 import org.sonar.server.user.UpdateUser;
 import org.sonar.server.user.UserSession;
 import org.sonar.server.user.UserUpdater;
@@ -60,7 +61,9 @@ public class UpdateLoginAction implements UsersWsAction {
         "Requires Administer System permission")
       .setSince("7.6")
       .setPost(true)
-      .setHandler(this);
+      .setHandler(this)
+      .setDeprecatedSince("10.4")
+      .setChangelog(new Change("10.4", "Deprecated. Use PATCH api/v2/users-management/users/{id} instead"));
 
     action.createParam(PARAM_LOGIN)
       .setRequired(true)