SONAR-6438 Sanitize description of WS sections

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 5909f21ee2c1961d027cb39eebcbd5f257ab72e7..320fae11b07e05495084e584a8e299caeb5cb66d 100644 (file)
--- 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 c1742b65fe6e2d4bc474c722553df9960eab765c..5b8d4b7f6eb182fa5c5c9e3ab77de8acec5747ac 100644 (file)
--- 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 c6c6984ba61acd3e7ef9264818b3dad1b59f6808..c7b8b93d1c944f997a4a9908e14dfd1ee6ba38aa 100644 (file)
--- 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 d38bc9b76bdc83431865fed9cfd8409ff773a453..34677e1a6dc6bb8f9cf1a9f9404a3c8598338886 100644 (file)
--- 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 fd0ef26b8cae211a26859c922bb800859bfb82e4..8de586023d02f3e6741279d94e4de4b7d7cf9154 100644 (file)
--- 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 ad2b6e0d91428cc301f0e467ecd09812ca72ec52..d50bb86daf57d0b542e6b573540672a56bad7258 100644 (file)
--- 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 24660092c3819f243e2be964620be15a9e1e507e..e81417b7133234fd9fbed67ae8d9b59ad769b261 100644 (file)
--- 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 049fd34097b831194ddb46318789592e373a93fe..12c7b1e9c728f971fc3722c0a9db8fe2f8dfa281 100644 (file)
--- 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 ff9ad2433c8c4d72d071a0d0f1ceac264b2011e5..51902513182ba2f77bb90294f29551d5466c957c 100644 (file)
--- 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.<br/>" +
+      .setDescription("Get detailed information about system configuration.<br/>" +
         "Requires 'Administer' permissions.<br/>" +
         "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 4bad445f2ed77ca7ab7b7a8f03372dda94c63275..33b75875f25d32dd51e00ea83eccb7b428917178 100644 (file)
--- 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 f496a214cb909dd71ac5d7594efb7bd69372d6fd..c5db56b5294c841e5640bea965302ef14ac588f2 100644 (file)
--- 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 634c6a4c714e668c5c2a4ef4203c1f0db0540f41..a17b91ec7cf96e12e3fb370f2592644ec6040a90 100644 (file)
--- 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 539699d9196484c9d6a79966713f9904691670b3..c7fc1ea90cbe1e698fa2f25f7da65bc6e461a43b 100644 (file)
--- 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 5ffb6f0fd3777f13e5e54ca9dbb319cfdd6cdd4b..b459f7a7e2223aba5b6cacf4d1f9f5aac49db297 100644 (file)
--- 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"))