SONAR-17502 Deprecate documentationPath field for plugins/installed endpoint

diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/plugins/ws/InstalledAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/plugins/ws/InstalledAction.java
index ed824818842ff283aa9ca5bd4c54b07680ebef38..92660a22639d2fa2b686519d506cf745256a00ba 100644 (file)
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/plugins/ws/InstalledAction.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/plugins/ws/InstalledAction.java
@@ -84,6 +84,7 @@ public class InstalledAction implements PluginsWsAction {
         "Requires authentication.")
       .setSince("5.2")
       .setChangelog(
+        new Change("9.8", "The 'documentationPath' field is deprecated"),
         new Change("9.7", "Authentication check added"),
         new Change("8.0", "The 'documentationPath' field is added"),
         new Change("7.0", "The fields 'compressedHash' and 'compressedFilename' are added"),

diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/plugins/ws/PendingAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/plugins/ws/PendingAction.java
index fc178005a8668b6ffe6cb9b71d1faeb0eae707e5..f07ad99f47df3a8b0860b283d694a636f8952bbf 100644 (file)
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/plugins/ws/PendingAction.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/plugins/ws/PendingAction.java
@@ -71,7 +71,10 @@ public class PendingAction implements PluginsWsAction {
       .setDescription("Get the list of plugins which will either be installed or removed at the next startup of the SonarQube instance, sorted by plugin name.<br/>" +
         "Require 'Administer System' permission.")
       .setSince("5.2")
-      .setChangelog(new Change("8.0", "The 'documentationPath' field is added"))
+      .setChangelog(
+        new Change("9.8", "The 'documentationPath' field is deprecated"),
+        new Change("8.0", "The 'documentationPath' field is added")
+      )
       .setHandler(this)
       .setResponseExample(this.getClass().getResource("example-pending_plugins.json"));
   }