From 457a6742f2611e38d10f15c6ca0c4874b8f32163 Mon Sep 17 00:00:00 2001 From: Stas Vilchik Date: Thu, 19 May 2016 14:22:41 +0200 Subject: [PATCH] SONAR-6438 Sanitize description of WS sections --- .../main/java/org/sonar/server/activity/ws/ActivitiesWs.java | 2 +- .../src/main/java/org/sonar/server/ce/ws/IsQueueEmptyWs.java | 2 +- .../main/java/org/sonar/server/component/ws/ResourcesWs.java | 2 +- .../main/java/org/sonar/server/dashboard/ws/DashboardsWs.java | 2 +- .../src/main/java/org/sonar/server/dashboard/ws/ShowAction.java | 2 +- .../src/main/java/org/sonar/server/issue/filter/AppAction.java | 2 +- .../java/org/sonar/server/issue/filter/FavoritesAction.java | 2 +- .../main/java/org/sonar/server/issue/filter/SearchAction.java | 2 +- .../src/main/java/org/sonar/server/platform/ws/InfoAction.java | 2 +- .../src/main/java/org/sonar/server/platform/ws/L10nWs.java | 2 +- .../src/main/java/org/sonar/server/platform/ws/LogsAction.java | 2 +- .../java/org/sonar/server/qualityprofile/ws/ProfilesWs.java | 2 +- .../src/main/java/org/sonar/server/rule/ws/AppAction.java | 2 +- .../src/main/java/org/sonar/server/rule/ws/ListAction.java | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/server/sonar-server/src/main/java/org/sonar/server/activity/ws/ActivitiesWs.java b/server/sonar-server/src/main/java/org/sonar/server/activity/ws/ActivitiesWs.java index 5909f21ee2c..320fae11b07 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/activity/ws/ActivitiesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/activity/ws/ActivitiesWs.java @@ -35,7 +35,7 @@ public class ActivitiesWs implements WebService { public void define(Context context) { NewController controller = context .createController(ENDPOINT) - .setDescription("Tracking of activities"); + .setDescription("Track activities."); search.define(controller); controller.done(); diff --git a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/IsQueueEmptyWs.java b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/IsQueueEmptyWs.java index c1742b65fe6..5b8d4b7f6eb 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/IsQueueEmptyWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/IsQueueEmptyWs.java @@ -43,7 +43,7 @@ public class IsQueueEmptyWs implements WebService { public void define(Context context) { NewController controller = context .createController(API_ENDPOINT) - .setDescription("For internal testing - do not use"); + .setDescription("Get details about Compute Engine tasks."); action.define(controller); controller.done(); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java b/server/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java index c6c6984ba61..c7b8b93d1c9 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java @@ -30,7 +30,7 @@ public class ResourcesWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController("api/resources") - .setDescription("Former components web api. Deprecated since 5.4.") + .setDescription("Get details about components. Deprecated since 5.4.") .setSince("2.10"); defineIndexAction(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/dashboard/ws/DashboardsWs.java b/server/sonar-server/src/main/java/org/sonar/server/dashboard/ws/DashboardsWs.java index d38bc9b76bd..34677e1a6dc 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/dashboard/ws/DashboardsWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/dashboard/ws/DashboardsWs.java @@ -33,7 +33,7 @@ public class DashboardsWs implements WebService { public void define(Context context) { NewController controller = context.createController("api/dashboards"); controller.setSince("5.0"); - controller.setDescription("Management of dashboards and widgets"); + controller.setDescription("Manage dashboards and widgets."); for (DashboardsWsAction action : actions) { action.define(controller); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/dashboard/ws/ShowAction.java b/server/sonar-server/src/main/java/org/sonar/server/dashboard/ws/ShowAction.java index fd0ef26b8ca..8de586023d0 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/dashboard/ws/ShowAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/dashboard/ws/ShowAction.java @@ -49,7 +49,7 @@ public class ShowAction implements DashboardsWsAction { @Override public void define(WebService.NewController newController) { WebService.NewAction action = newController.createAction("show") - .setDescription("Detail of a dashboard (name, description, layout and widgets)") + .setDescription("Get details of a dashboard (name, description, layout and widgets).") .setInternal(true) .setSince("5.0") .setResponseExample(getClass().getResource("show-example.json")) diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/filter/AppAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/filter/AppAction.java index ad2b6e0d914..d50bb86daf5 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/filter/AppAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/filter/AppAction.java @@ -43,7 +43,7 @@ public class AppAction implements IssueFilterWsAction { public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("app"); action - .setDescription("Data required for rendering the page 'Issues'") + .setDescription("Get data required for rendering the page 'Issues'.") .setSince("4.2") .setInternal(true) .setHandler(this) diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/filter/FavoritesAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/filter/FavoritesAction.java index 24660092c38..e81417b7133 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/filter/FavoritesAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/filter/FavoritesAction.java @@ -40,7 +40,7 @@ public class FavoritesAction implements IssueFilterWsAction { public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("favorites"); action - .setDescription("The issue filters marked as favorite by request user") + .setDescription("List issue filters marked as favorite by request user.") .setResponseExample(getClass().getResource("favorites-example.json")) .setSince("4.2") .setHandler(this); diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/filter/SearchAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/filter/SearchAction.java index 049fd34097b..12c7b1e9c72 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/filter/SearchAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/filter/SearchAction.java @@ -52,7 +52,7 @@ public class SearchAction implements IssueFilterWsAction { public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("search"); action - .setDescription("List of current user issue filters and shared issue filters.") + .setDescription("List issue filters and shared issue filters of the current user.") .setHandler(this) .setSince("5.2") .setResponseExample(getClass().getResource("search-example.json")); diff --git a/server/sonar-server/src/main/java/org/sonar/server/platform/ws/InfoAction.java b/server/sonar-server/src/main/java/org/sonar/server/platform/ws/InfoAction.java index ff9ad2433c8..51902513182 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/platform/ws/InfoAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/platform/ws/InfoAction.java @@ -50,7 +50,7 @@ public class InfoAction implements SystemWsAction { @Override public void define(WebService.NewController controller) { controller.createAction("info") - .setDescription("Detailed information about system configuration.
" + + .setDescription("Get detailed information about system configuration.
" + "Requires 'Administer' permissions.
" + "Since 5.5, this web service becomes internal in order to more easily update result.") .setSince("5.1") diff --git a/server/sonar-server/src/main/java/org/sonar/server/platform/ws/L10nWs.java b/server/sonar-server/src/main/java/org/sonar/server/platform/ws/L10nWs.java index 4bad445f2ed..33b75875f25 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/platform/ws/L10nWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/platform/ws/L10nWs.java @@ -49,7 +49,7 @@ public class L10nWs implements WebService { @Override public void define(Context context) { NewController l10n = context.createController("api/l10n"); - l10n.setDescription("Localization") + l10n.setDescription("Manage localization.") .setSince("4.4"); NewAction indexAction = l10n.createAction("index") .setInternal(true) diff --git a/server/sonar-server/src/main/java/org/sonar/server/platform/ws/LogsAction.java b/server/sonar-server/src/main/java/org/sonar/server/platform/ws/LogsAction.java index f496a214cb9..c5db56b5294 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/platform/ws/LogsAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/platform/ws/LogsAction.java @@ -42,7 +42,7 @@ public class LogsAction implements SystemWsAction { @Override public void define(WebService.NewController controller) { controller.createAction("logs") - .setDescription("System logs in plain-text format. Requires system administration permission.") + .setDescription("Get system logs in plain-text format. Requires system administration permission.") .setResponseExample(getClass().getResource("logs-example.log")) .setSince("5.2") .setHandler(this); diff --git a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ProfilesWs.java b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ProfilesWs.java index 634c6a4c714..a17b91ec7cf 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ProfilesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ProfilesWs.java @@ -42,7 +42,7 @@ public class ProfilesWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController(API_ENDPOINT) - .setDescription("Old Quality Profiles. Deprecated since 5.2") + .setDescription("Manage quality profiles. Deprecated since 5.2.") .setSince("4.4"); diff --git a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/AppAction.java b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/AppAction.java index 539699d9196..c7fc1ea90cb 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/AppAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/AppAction.java @@ -58,7 +58,7 @@ public class AppAction implements RulesWsAction { @Override public void define(WebService.NewController controller) { controller.createAction("app") - .setDescription("Data required for rendering the page 'Coding Rules'") + .setDescription("Get data required for rendering the page 'Coding Rules'.") .setResponseExample(getClass().getResource("app-example.json")) .setSince("4.5") .setInternal(true) diff --git a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/ListAction.java b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/ListAction.java index 5ffb6f0fd37..b459f7a7e22 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/ListAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/ListAction.java @@ -44,7 +44,7 @@ public class ListAction implements RulesWsAction { public void define(WebService.NewController controller) { controller .createAction("list") - .setDescription("List of rules, excluding the manual rules and the rules with status REMOVED. JSON format is not supported for response.") + .setDescription("List rules, excluding the manual rules and the rules with status REMOVED. JSON format is not supported for response.") .setSince("5.2") .setInternal(true) .setResponseExample(getClass().getResource("list-example.txt")) -- 2.39.5