From 80418249fe5b1f8cf3ee10f4f80d538351fd106c Mon Sep 17 00:00:00 2001 From: Julien Lancelot Date: Mon, 3 Sep 2018 12:36:06 +0200 Subject: [PATCH] SONAR-11184 Deprecate custom measure feature --- .../org/sonar/server/measure/custom/ws/CreateAction.java | 1 + .../org/sonar/server/measure/custom/ws/CustomMeasuresWs.java | 3 ++- .../org/sonar/server/measure/custom/ws/DeleteAction.java | 1 + .../org/sonar/server/measure/custom/ws/MetricsAction.java | 1 + .../org/sonar/server/measure/custom/ws/SearchAction.java | 1 + .../org/sonar/server/measure/custom/ws/UpdateAction.java | 3 ++- .../ws/client/custommeasures/CustomMeasuresService.java | 5 +++++ 7 files changed, 13 insertions(+), 2 deletions(-) diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CreateAction.java b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CreateAction.java index 69dbbe4e213..8e9ca1ebc23 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CreateAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CreateAction.java @@ -76,6 +76,7 @@ public class CreateAction implements CustomMeasuresWsAction { "The project id or the project key must be provided (only project and module custom measures can be created). The metric id or the metric key must be provided.
" + "Requires 'Administer' permission on the project.") .setSince("5.2") + .setDeprecatedSince("7.4") .setPost(true) .setHandler(this); diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CustomMeasuresWs.java b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CustomMeasuresWs.java index 287c412403e..046d4107817 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CustomMeasuresWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CustomMeasuresWs.java @@ -33,7 +33,8 @@ public class CustomMeasuresWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController(ENDPOINT) - .setDescription("Manage custom measures for a project. See also api/metrics.") + .setDescription("Manage custom measures for a project. See also api/metrics.
" + + "Custom measures are deprecated. Please use projects tags instead.") .setSince("5.2"); for (CustomMeasuresWsAction action : actions) { diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/DeleteAction.java b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/DeleteAction.java index e9130a9d4af..2acada0c06d 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/DeleteAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/DeleteAction.java @@ -50,6 +50,7 @@ public class DeleteAction implements CustomMeasuresWsAction { .setPost(true) .setHandler(this) .setSince("5.2") + .setDeprecatedSince("7.4") .setDescription("Delete a custom measure.
Requires 'Administer System' permission or 'Administer' permission on the project."); action.createParam(PARAM_ID) diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/MetricsAction.java b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/MetricsAction.java index 7d4170ca9ab..671684e92e6 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/MetricsAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/MetricsAction.java @@ -56,6 +56,7 @@ public class MetricsAction implements CustomMeasuresWsAction { public void define(WebService.NewController context) { WebService.NewAction action = context.createAction(ACTION) .setSince("5.2") + .setDeprecatedSince("7.4") .setInternal(true) .setHandler(this) .setResponseExample(Resources.getResource(getClass(), "example-metrics.json")) diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/SearchAction.java b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/SearchAction.java index 14af7c1a21c..80bd37b5ce9 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/SearchAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/SearchAction.java @@ -76,6 +76,7 @@ public class SearchAction implements CustomMeasuresWsAction { .setDescription("List custom measures. The project id or project key must be provided.
" + "Requires 'Administer System' permission or 'Administer' permission on the project.") .setSince("5.2") + .setDeprecatedSince("7.4") .addFieldsParam(CustomMeasureJsonWriter.OPTIONAL_FIELDS) .addPagingParams(100, MAX_LIMIT) .setResponseExample(getClass().getResource("example-search.json")) diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/UpdateAction.java b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/UpdateAction.java index 7e83e7a02e1..75416b28874 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/UpdateAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/UpdateAction.java @@ -66,7 +66,8 @@ public class UpdateAction implements CustomMeasuresWsAction { .setDescription("Update a custom measure. Value and/or description must be provided
" + "Requires 'Administer System' permission or 'Administer' permission on the project.") .setHandler(this) - .setSince("5.2"); + .setSince("5.2") + .setDeprecatedSince("7.4"); action.createParam(PARAM_ID) .setRequired(true) diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CustomMeasuresService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CustomMeasuresService.java index dc11d7801ac..59936afd26e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CustomMeasuresService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CustomMeasuresService.java @@ -43,6 +43,7 @@ public class CustomMeasuresService extends BaseService { * This is a POST request. * @see Further information about this action online (including a response example) * @since 5.2 + * @deprecated since 7.4 */ public void create(CreateRequest request) { call( @@ -63,6 +64,7 @@ public class CustomMeasuresService extends BaseService { * This is a POST request. * @see Further information about this action online (including a response example) * @since 5.2 + * @deprecated since 7.4 */ public void delete(DeleteRequest request) { call( @@ -78,6 +80,7 @@ public class CustomMeasuresService extends BaseService { * This is a GET request. * @see Further information about this action online (including a response example) * @since 5.2 + * @deprecated since 7.4 */ public String metrics(MetricsRequest request) { return call( @@ -94,6 +97,7 @@ public class CustomMeasuresService extends BaseService { * This is a GET request. * @see Further information about this action online (including a response example) * @since 5.2 + * @deprecated since 7.4 */ public String search(SearchRequest request) { return call( @@ -113,6 +117,7 @@ public class CustomMeasuresService extends BaseService { * This is a POST request. * @see Further information about this action online (including a response example) * @since 5.2 + * @deprecated since 7.4 */ public void update(UpdateRequest request) { call( -- 2.39.5