diff options
16 files changed, 28 insertions, 26 deletions
diff --git a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ActivityAction.java b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ActivityAction.java index ec0cea60a2d..cbfeae84bc7 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ActivityAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ActivityAction.java @@ -146,7 +146,7 @@ public class ActivityAction implements CeWsAction { action.createParam(Param.PAGE) .setDescription("Deprecated parameter") .setDeprecatedSince("5.5") - .setDeprecatedKey("pageIndex"); + .setDeprecatedKey("pageIndex", "5.4"); action.addPageSize(100, MAX_PAGE_SIZE); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/BulkChangeAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/BulkChangeAction.java index ee90f02e429..f9befa1c0e0 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/BulkChangeAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/BulkChangeAction.java @@ -139,18 +139,18 @@ public class BulkChangeAction implements IssuesWsAction { action.createParam(PARAM_ASSIGN) .setDescription("To assign the list of issues to a specific user (login), or un-assign all the issues") .setExampleValue("john.smith") - .setDeprecatedKey("assign.assignee"); + .setDeprecatedKey("assign.assignee", "6.2"); action.createParam(PARAM_SET_SEVERITY) .setDescription("To change the severity of the list of issues") .setExampleValue(BLOCKER) .setPossibleValues(Severity.ALL) - .setDeprecatedKey("set_severity.severity"); + .setDeprecatedKey("set_severity.severity", "6.2"); action.createParam(PARAM_SET_TYPE) .setDescription("To change the type of the list of issues") .setExampleValue(BUG) .setPossibleValues(RuleType.names()) .setSince("5.5") - .setDeprecatedKey("set_type.type"); + .setDeprecatedKey("set_type.type", "6.2"); action.createParam(PARAM_PLAN) .setDescription("In 5.5, action plans are dropped. Has no effect. To plan the list of issues to a specific action plan (key), or unlink all the issues from an action plan") .setDeprecatedSince("5.5"); @@ -158,15 +158,15 @@ public class BulkChangeAction implements IssuesWsAction { .setDescription("Transition") .setExampleValue(REOPEN) .setPossibleValues(DefaultTransitions.ALL) - .setDeprecatedKey("do_transition.transition"); + .setDeprecatedKey("do_transition.transition", "6.2"); action.createParam(PARAM_ADD_TAGS) .setDescription("Add tags") .setExampleValue("security,java8") - .setDeprecatedKey("add_tags.tags"); + .setDeprecatedKey("add_tags.tags", "6.2"); action.createParam(PARAM_REMOVE_TAGS) .setDescription("Remove tags") .setExampleValue("security,java8") - .setDeprecatedKey("remove_tags.tags"); + .setDeprecatedKey("remove_tags.tags", "6.2"); action.createParam(PARAM_COMMENT) .setDescription("To add a comment to a list of issues") .setExampleValue("Here is my comment"); diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.java index b5c1fe8c99f..f8a1720265e 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/DeleteCommentAction.java @@ -70,7 +70,7 @@ public class DeleteCommentAction implements IssuesWsAction { action.createParam(PARAM_COMMENT) .setDescription("Comment key") - .setDeprecatedKey("key") + .setDeprecatedKey("key", "6.3") .setSince("6.3") .setRequired(true) .setExampleValue(UUID_EXAMPLE_01); diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java index dea982f1d73..df1248790bb 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/EditCommentAction.java @@ -76,7 +76,7 @@ public class EditCommentAction implements IssuesWsAction { action.createParam(PARAM_COMMENT) .setDescription("Comment key") - .setDeprecatedKey("key") + .setDeprecatedKey("key", "6.3") .setSince("6.3") .setRequired(true) .setExampleValue(UUID_EXAMPLE_01); diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SearchAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SearchAction.java index 06cce4c77bf..ab5dd8ba3aa 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SearchAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SearchAction.java @@ -253,12 +253,14 @@ public class SearchAction implements IssuesWsAction { action.createParam(PARAM_PROJECTS) .setDeprecatedSince("5.1") .setDescription("See projectKeys"); + action.createParam(PARAM_PROJECT_KEYS) .setDescription("To retrieve issues associated to a specific list of projects (comma-separated list of project keys). " + INTERNAL_PARAMETER_DISCLAIMER + "If this parameter is set, projectUuids must not be set.") - .setDeprecatedKey(PARAM_PROJECTS) + .setDeprecatedKey(PARAM_PROJECTS, "6.3") .setExampleValue(KEY_PROJECT_EXAMPLE_001); + action.createParam(PARAM_PROJECT_UUIDS) .setDescription("To retrieve issues associated to a specific list of projects (comma-separated list of project UUIDs). " + INTERNAL_PARAMETER_DISCLAIMER + diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SetTagsAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SetTagsAction.java index 1e3e26f4644..79250c1c12b 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SetTagsAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SetTagsAction.java @@ -60,7 +60,7 @@ public class SetTagsAction implements IssuesWsAction { action.createParam(PARAM_ISSUE) .setDescription("Issue key") .setSince("6.3") - .setDeprecatedKey("key") + .setDeprecatedKey("key", "6.3") .setExampleValue(Uuids.UUID_EXAMPLE_01) .setRequired(true); action.createParam(PARAM_TAGS) diff --git a/server/sonar-server/src/main/java/org/sonar/server/project/ws/CreateAction.java b/server/sonar-server/src/main/java/org/sonar/server/project/ws/CreateAction.java index e87c06105df..07fd764887a 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/project/ws/CreateAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/project/ws/CreateAction.java @@ -77,7 +77,7 @@ public class CreateAction implements ProjectsWsAction { action.createParam(PARAM_PROJECT) .setDescription("Key of the project") - .setDeprecatedKey(DEPRECATED_PARAM_KEY) + .setDeprecatedKey(DEPRECATED_PARAM_KEY, "6.3") .setRequired(true) .setExampleValue(KEY_PROJECT_EXAMPLE_001); diff --git a/server/sonar-server/src/main/java/org/sonar/server/project/ws/IndexAction.java b/server/sonar-server/src/main/java/org/sonar/server/project/ws/IndexAction.java index 91bd14e0899..fb1a9b7eaa1 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/project/ws/IndexAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/project/ws/IndexAction.java @@ -150,7 +150,7 @@ public class IndexAction implements ProjectsWsAction { private static void addRemovedParameter(String key, WebService.NewAction action) { action.createParam(key) .setDescription("Since 6.3, this parameter has no effect") - .setDeprecatedKey("6.3"); + .setDeprecatedSince("6.3"); } } diff --git a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/CreateAction.java b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/CreateAction.java index 990b289c867..5ad2bf5b618 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/CreateAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/CreateAction.java @@ -85,7 +85,7 @@ public class CreateAction implements QProfileWsAction { create.createParam(PARAM_PROFILE_NAME) .setDescription("The name for the new quality profile. Since 6.1, this parameter has been renamed from '%s' to '%s'", DEPRECATED_PARAM_PROFILE_NAME, PARAM_PROFILE_NAME) .setExampleValue("My Sonar way") - .setDeprecatedKey(DEPRECATED_PARAM_PROFILE_NAME) + .setDeprecatedKey(DEPRECATED_PARAM_PROFILE_NAME, "6.3") .setRequired(true); create.createParam(PARAM_LANGUAGE) diff --git a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ExportAction.java b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ExportAction.java index f7c4d056202..f2f8a884a51 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ExportAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ExportAction.java @@ -95,7 +95,7 @@ public class ExportAction implements QProfileWsAction { "Possible values are described by api/qualityprofiles/exporters.") .setPossibleValues(exporterKeys) // This deprecated key is only there to be able to deal with redirection from /profiles/export - .setDeprecatedKey("format"); + .setDeprecatedKey("format", "6.3"); } } diff --git a/server/sonar-server/src/main/java/org/sonar/server/setting/ws/ResetAction.java b/server/sonar-server/src/main/java/org/sonar/server/setting/ws/ResetAction.java index ca71f596b75..060eccd8333 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/setting/ws/ResetAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/setting/ws/ResetAction.java @@ -82,7 +82,7 @@ public class ResetAction implements SettingsWsAction { .setRequired(true); action.createParam(PARAM_COMPONENT) .setDescription("Component key") - .setDeprecatedKey("componentKey") + .setDeprecatedKey("componentKey", "6.3") .setExampleValue(KEY_PROJECT_EXAMPLE_001); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/setting/ws/SetAction.java b/server/sonar-server/src/main/java/org/sonar/server/setting/ws/SetAction.java index bdcfee1f6a3..1e973658911 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/setting/ws/SetAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/setting/ws/SetAction.java @@ -122,7 +122,7 @@ public class SetAction implements SettingsWsAction { action.createParam(PARAM_COMPONENT) .setDescription("Component key") - .setDeprecatedKey("componentKey") + .setDeprecatedKey("componentKey", "6.3") .setExampleValue(KEY_PROJECT_EXAMPLE_001); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/user/ws/CreateAction.java b/server/sonar-server/src/main/java/org/sonar/server/user/ws/CreateAction.java index 501f0123843..4900cefc46e 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/user/ws/CreateAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/user/ws/CreateAction.java @@ -88,7 +88,7 @@ public class CreateAction implements UsersWsAction { action.createParam(PARAM_SCM_ACCOUNTS) .setDescription("This parameter is deprecated, please use '%s' instead", PARAM_SCM_ACCOUNT) - .setDeprecatedKey(PARAM_SCM_ACCOUNTS_DEPRECATED) + .setDeprecatedKey(PARAM_SCM_ACCOUNTS_DEPRECATED, "6.0") .setDeprecatedSince("6.1") .setExampleValue("myscmaccount1,myscmaccount2"); diff --git a/server/sonar-server/src/main/java/org/sonar/server/user/ws/UpdateAction.java b/server/sonar-server/src/main/java/org/sonar/server/user/ws/UpdateAction.java index fbf136efe47..3a544a862ce 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/user/ws/UpdateAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/user/ws/UpdateAction.java @@ -85,7 +85,7 @@ public class UpdateAction implements UsersWsAction { action.createParam(PARAM_SCM_ACCOUNTS) .setDescription("This parameter is deprecated, please use '%s' instead", PARAM_SCM_ACCOUNT) - .setDeprecatedKey(PARAM_SCM_ACCOUNTS_DEPRECATED) + .setDeprecatedKey(PARAM_SCM_ACCOUNTS_DEPRECATED, "6.0") .setDeprecatedSince("6.1") .setExampleValue("myscmaccount1,myscmaccount2"); 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 6df00f73641..4ed296fcab1 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 @@ -348,13 +348,13 @@ public interface WebService extends Definable<WebService.Context> { createParam(Param.PAGE) .setDescription("1-based page number") .setExampleValue("42") - .setDeprecatedKey("pageIndex") + .setDeprecatedKey("pageIndex", "5.2") .setDefaultValue("1"); createParam(Param.PAGE_SIZE) .setDescription("Page size. Must be greater than 0.") .setExampleValue("20") - .setDeprecatedKey("pageSize") + .setDeprecatedKey("pageSize", "5.2") .setDefaultValue(String.valueOf(defaultPageSize)); return this; } @@ -373,7 +373,7 @@ public interface WebService extends Definable<WebService.Context> { createParam(Param.PAGE) .setDescription("1-based page number") .setExampleValue("42") - .setDeprecatedKey("pageIndex") + .setDeprecatedKey("pageIndex", "5.2") .setDefaultValue("1"); return this; } @@ -382,7 +382,7 @@ public interface WebService extends Definable<WebService.Context> { createParam(Param.PAGE_SIZE) .setDescription("Page size. Must be greater than 0 and less than " + maxPageSize) .setExampleValue("20") - .setDeprecatedKey("pageSize") + .setDeprecatedKey("pageSize", "5.2") .setDefaultValue(String.valueOf(defaultPageSize)); return this; } @@ -437,7 +437,7 @@ public interface WebService extends Definable<WebService.Context> { return createParam(Param.SORT) .setDescription("Sort field") - .setDeprecatedKey("sort") + .setDeprecatedKey("sort", "5.4") .setDefaultValue(defaultValue) .setPossibleValues(possibleValues); } diff --git a/sonar-plugin-api/src/test/java/org/sonar/api/server/ws/RequestTest.java b/sonar-plugin-api/src/test/java/org/sonar/api/server/ws/RequestTest.java index a22ad478c7f..4c299ae37ae 100644 --- a/sonar-plugin-api/src/test/java/org/sonar/api/server/ws/RequestTest.java +++ b/sonar-plugin-api/src/test/java/org/sonar/api/server/ws/RequestTest.java @@ -636,8 +636,8 @@ public class RequestTest { action.createParam("has_possible_values").setPossibleValues("foo", "bar"); - action.createParam("new_param").setDeprecatedKey("deprecated_param"); - action.createParam("new_param_with_default_value").setDeprecatedKey("deprecated_new_param_with_default_value").setDefaultValue("the_default_string"); + action.createParam("new_param").setDeprecatedKey("deprecated_param", "6.3"); + action.createParam("new_param_with_default_value").setDeprecatedKey("deprecated_new_param_with_default_value", "6.2").setDefaultValue("the_default_string"); controller.done(); } |