SONAR-8793 Add since to the deprecated key of an active parameter

2 files changed, 27 insertions, 1 deletions

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java b/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java
index 8a0c71fb60d..6df00f73641 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java
@@ -600,6 +600,7 @@ public interface WebService extends Definable<WebService.Context> {
     private String since;
     private String deprecatedSince;
     private String deprecatedKey;
+    private String deprecatedKeySince;
     private String description;
     private String exampleValue;
     private String defaultValue;
@@ -629,12 +630,26 @@ public interface WebService extends Definable<WebService.Context> {
 
     /**
      * @since 5.0
+     * @deprecated since 6.4
+     * @see #setDeprecatedKey(String, String) 
      */
+    @Deprecated
     public NewParam setDeprecatedKey(@Nullable String s) {
       this.deprecatedKey = s;
       return this;
     }
 
+    /**
+     *
+     * @param deprecatedSince Version when the old key was replaced/deprecated. Ex: 5.6
+     * @since 6.4
+     */
+    public NewParam setDeprecatedKey(@Nullable String key, @Nullable String deprecatedSince) {
+      this.deprecatedKey = key;
+      this.deprecatedKeySince = deprecatedSince;
+      return this;
+    }
+
     public NewParam setDescription(@Nullable String description) {
       this.description = description;
       return this;
@@ -767,6 +782,7 @@ public interface WebService extends Definable<WebService.Context> {
     private final String since;
     private final String deprecatedSince;
     private final String deprecatedKey;
+    private final String deprecatedKeySince;
     private final String description;
     private final String exampleValue;
     private final String defaultValue;
@@ -779,6 +795,7 @@ public interface WebService extends Definable<WebService.Context> {
       this.since = newParam.since;
       this.deprecatedSince = newParam.deprecatedSince;
       this.deprecatedKey = newParam.deprecatedKey;
+      this.deprecatedKeySince = newParam.deprecatedKeySince;
       this.description = newParam.description;
       this.exampleValue = newParam.exampleValue;
       this.defaultValue = newParam.defaultValue;
@@ -818,6 +835,14 @@ public interface WebService extends Definable<WebService.Context> {
       return deprecatedKey;
     }
 
+    /**
+     * @since 6.4
+     */
+    @CheckForNull
+    public String deprecatedKeySince() {
+      return deprecatedKeySince;
+    }
+
     @CheckForNull
     public String description() {
       return description;
diff --git a/sonar-plugin-api/src/test/java/org/sonar/api/server/ws/WebServiceTest.java b/sonar-plugin-api/src/test/java/org/sonar/api/server/ws/WebServiceTest.java
index 9ef9e8650b0..c71c6eda689 100644
--- a/sonar-plugin-api/src/test/java/org/sonar/api/server/ws/WebServiceTest.java
+++ b/sonar-plugin-api/src/test/java/org/sonar/api/server/ws/WebServiceTest.java
@@ -221,7 +221,7 @@ public class WebServiceTest {
           .setDefaultValue("MAJOR")
           .setSince("4.4")
           .setDeprecatedSince("5.3")
-          .setDeprecatedKey("old-severity")
+          .setDeprecatedKey("old-severity", "4.5")
           .setPossibleValues("INFO", "MAJOR", "BLOCKER");
         newAction.createParam("internal")
           .setInternal(true);
@@ -247,6 +247,7 @@ public class WebServiceTest {
     assertThat(severityParam.deprecatedSince()).isEqualTo("5.3");
     assertThat(severityParam.since()).isEqualTo("4.4");
     assertThat(severityParam.deprecatedKey()).isEqualTo("old-severity");
+    assertThat(severityParam.deprecatedKeySince()).isEqualTo("4.5");
     assertThat(severityParam.defaultValue()).isEqualTo("MAJOR");
     assertThat(severityParam.possibleValues()).containsOnly("INFO", "MAJOR", "BLOCKER");