SONAR-5111 Add some missing description and since parameters

diff --git a/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java b/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java
index eeeac66e9def7e0080ac3863c8974580668c2bc3..e7c2552b865c82e8489d8f2d1ee39eea716cd136 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java
@@ -29,6 +29,7 @@ public class ResourcesWs implements WebService {
   @Override
   public void define(Context context) {
     NewController controller = context.createController("api/resources")
+      .setDescription("Former components web service")
       .setSince("2.10");
 
     defineSystemAction(controller);

diff --git a/sonar-server/src/main/java/org/sonar/server/issue/actionplan/ActionPlanWs.java b/sonar-server/src/main/java/org/sonar/server/issue/actionplan/ActionPlanWs.java
index 8842cbc17a080c5359f00d78e1cd818f31ac5fcc..e8cd57aeac45d32816ceb8af9cd11cf004fab718 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/issue/actionplan/ActionPlanWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/issue/actionplan/ActionPlanWs.java
@@ -29,7 +29,7 @@ public class ActionPlanWs implements WebService {
   @Override
   public void define(Context context) {
     NewController controller = context.createController("api/action_plans");
-    controller.setDescription("Action plans");
+    controller.setDescription("Action plans management");
 
     WebService.NewAction search = controller.createAction("search")
       .setDescription("Get a list of action plans. Requires Browse permission on project")

diff --git a/sonar-server/src/main/java/org/sonar/server/issue/filter/IssueFilterWs.java b/sonar-server/src/main/java/org/sonar/server/issue/filter/IssueFilterWs.java
index aba50b9c285311381d27853b9ff151e210ee79b2..e9569badf4b1d730a45e4ef3efae4c859fa98ea8 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/issue/filter/IssueFilterWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/issue/filter/IssueFilterWs.java
@@ -37,7 +37,7 @@ public class IssueFilterWs implements WebService {
   public void define(Context context) {
     NewController controller = context.createController("api/issue_filters")
       .setSince("4.2")
-      .setDescription("Issue Filters");
+      .setDescription("Issue Filters management");
     appAction.define(controller);
     showAction.define(controller);
     favoritesAction.define(controller);

diff --git a/sonar-server/src/main/java/org/sonar/server/measure/ws/TimeMachineWs.java b/sonar-server/src/main/java/org/sonar/server/measure/ws/TimeMachineWs.java
index 990ac5b7f2e03c95a241ac94baffb3d64d3c217f..153ad047268d3abc88e0adb8f9b8215a3176c1ac 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/measure/ws/TimeMachineWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/measure/ws/TimeMachineWs.java
@@ -29,6 +29,7 @@ public class TimeMachineWs implements WebService {
   @Override
   public void define(Context context) {
     NewController controller = context.createController("api/timemachine")
+      .setDescription("Get a list of past measures")
       .setSince("2.10");
 
     defineSystemAction(controller);

diff --git a/sonar-server/src/main/java/org/sonar/server/platform/ws/ServerWs.java b/sonar-server/src/main/java/org/sonar/server/platform/ws/ServerWs.java
index c95fd3c415b954963f68a1fea512ea50fb6acb18..7a51f55474881911ccdc375dc657901631a32343 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/platform/ws/ServerWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/platform/ws/ServerWs.java
@@ -29,6 +29,7 @@ public class ServerWs implements WebService {
   @Override
   public void define(Context context) {
     NewController controller = context.createController("api/server")
+      .setDescription("Get system properties and upgrade db")
       .setSince("2.10");
 
     defineSystemAction(controller);

diff --git a/sonar-server/src/main/java/org/sonar/server/platform/ws/SystemWs.java b/sonar-server/src/main/java/org/sonar/server/platform/ws/SystemWs.java
index 282eb8b840fab314c900c12756ba0860bc1a0129..3ed0f57e605a6cfd4768a918003792c2ff3c26e4 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/platform/ws/SystemWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/platform/ws/SystemWs.java
@@ -32,6 +32,7 @@ public class SystemWs implements WebService {
   @Override
   public void define(Context context) {
     NewController controller = context.createController("api/system")
+      .setDescription("Restart server")
       .setSince("4.3");
 
     restartHandler.define(controller);

diff --git a/sonar-server/src/main/java/org/sonar/server/plugins/BatchWs.java b/sonar-server/src/main/java/org/sonar/server/plugins/BatchWs.java
index 228c36581faf0ac5c985bd7f121714aab4a2db92..a2d5b2cb334a12b041b7b52d6c360220960cc649 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/plugins/BatchWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/plugins/BatchWs.java
@@ -73,7 +73,9 @@ public class BatchWs implements WebService, Startable {
 
   @Override
   public void define(Context context) {
-    NewController controller = context.createController("batch");
+    NewController controller = context.createController("batch")
+      .setSince("4.4")
+      .setDescription("Get JAR files for batch");
     controller.createAction("index")
       .setInternal(true)
       .setDescription("List the JAR files to be downloaded by source analyzer")

diff --git a/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRuleAction.java b/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRuleAction.java
index 445609287b3195b243c7d79cfaa74779d7458b58..a621f400f249686e2b84b502160ddf782148f7e9 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRuleAction.java
+++ b/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRuleAction.java
@@ -37,26 +37,37 @@ public class ActivateRuleAction implements RequestHandler {
   void define(WebService.NewController controller) {
     WebService.NewAction action = controller
       .createAction("activate_rule")
+      .setDescription("Activate a rule on a Quality profile")
       .setHandler(this)
       .setPost(true)
       .setSince("4.4");
 
     action.createParam("profile_lang")
-      .setRequired(true);
+      .setDescription("Profile language")
+      .setRequired(true)
+      .setExampleValue("java");
 
     action.createParam("profile_name")
-      .setRequired(true);
+      .setDescription("Profile name")
+      .setRequired(true)
+      .setExampleValue("My profile");
 
     action.createParam("rule_repo")
-      .setRequired(true);
+      .setDescription("Rule repository")
+      .setRequired(true)
+      .setExampleValue("squid");
 
     action.createParam("rule_key")
-      .setRequired(true);
+      .setDescription("Rule key")
+      .setRequired(true)
+      .setExampleValue("AvoidCycles");
 
     action.createParam("severity")
+      .setDescription("Severity")
       .setPossibleValues(Severity.ALL);
 
-    action.createParam("params");
+    action.createParam("params")
+      .setDescription("Parameters");
   }
 
   @Override

diff --git a/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ProfilesWs.java b/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ProfilesWs.java
index 2446cc7203aaa0eb017eb644d5134cdb6546778f..2b34d05453f320894591ee96301006ac25c6c32f 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ProfilesWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ProfilesWs.java
@@ -32,7 +32,7 @@ public class ProfilesWs implements WebService {
   @Override
   public void define(Context context) {
     NewController controller = context.createController("api/profiles")
-      .setDescription("Quality profiles management (implemented in Rails)");
+      .setDescription("Former quality profiles web service");
 
     defineListAction(controller);
     defineBackupAction(controller);

diff --git a/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleTagsWs.java b/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleTagsWs.java
index 5dbcef623abb34073524d0b4f9e95b032679d342..69801e05e433bf9138d0f40e89098fa7ad8a1854 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleTagsWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleTagsWs.java
@@ -38,7 +38,7 @@ public class RuleTagsWs implements WebService {
   @Override
   public void define(Context context) {
     NewController controller = context.createController("api/rule_tags")
-      .setDescription("Rule tags");
+      .setDescription("Rule tags management");
 
     controller.createAction("list")
       .setDescription("List all available rule tags")
@@ -60,7 +60,9 @@ public class RuleTagsWs implements WebService {
           create(request, response);
         }
       })
-      .createParam("tag").setDescription("Value of the new rule tag");
+      .createParam("tag")
+      .setDescription("Value of the new rule tag")
+      .setExampleValue("java8");
 
     controller.done();
   }

diff --git a/sonar-server/src/main/java/org/sonar/server/source/ws/SourcesWs.java b/sonar-server/src/main/java/org/sonar/server/source/ws/SourcesWs.java
index d04d656fe113cefd08b62f604a6f67aaa7c569db..b0ad99bcc66a995cef34e27150b0046c23597587 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/source/ws/SourcesWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/source/ws/SourcesWs.java
@@ -34,7 +34,9 @@ public class SourcesWs implements WebService {
 
   @Override
   public void define(Context context) {
-    NewController controller = context.createController("api/sources");
+    NewController controller = context.createController("api/sources")
+      .setSince("4.2")
+      .setDescription("Display sources information");
     showAction.define(controller);
     scmAction.define(controller);
     controller.done();

diff --git a/sonar-server/src/main/java/org/sonar/server/updatecenter/ws/UpdateCenterWs.java b/sonar-server/src/main/java/org/sonar/server/updatecenter/ws/UpdateCenterWs.java
index 5f568b8e2efe73b578d0e4a8c233fc3817118653..b777f6a73cbc45b40590cd3305fe5175ae42d5b4 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/updatecenter/ws/UpdateCenterWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/updatecenter/ws/UpdateCenterWs.java
@@ -29,6 +29,7 @@ public class UpdateCenterWs implements WebService {
   @Override
   public void define(Context context) {
     NewController controller = context.createController("api/updatecenter")
+      .setDescription("Get list of installed plugins")
       .setSince("2.10");
 
     defineInstalledPluginsAction(controller);

diff --git a/sonar-server/src/main/java/org/sonar/server/ws/ListingWs.java b/sonar-server/src/main/java/org/sonar/server/ws/ListingWs.java
index 81891d5907911e71e84d39b4b30b2ff1ce31817f..6cafb46670b2d3ce6d192cf40813420d52538035 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/ws/ListingWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/ws/ListingWs.java
@@ -42,6 +42,7 @@ public class ListingWs implements WebService {
   public void define(final Context context) {
     NewController controller = context
       .createController("api/webservices")
+      .setSince("4.2")
       .setDescription("List web services");
     defineList(context, controller);
     defineResponseExample(context, controller);
@@ -52,6 +53,7 @@ public class ListingWs implements WebService {
     NewAction action = controller
       .createAction("list")
       .setSince("4.2")
+      .setDescription("List web services")
       .setHandler(new RequestHandler() {
         @Override
         public void handle(Request request, Response response) {
@@ -69,6 +71,8 @@ public class ListingWs implements WebService {
   private void defineResponseExample(final Context context, NewController controller) {
     NewAction action = controller
       .createAction("response_example")
+      .setDescription("Display web service response example")
+      .setSince("4.4")
       .setHandler(new RequestHandler() {
         @Override
         public void handle(Request request, Response response) throws Exception {
@@ -77,8 +81,14 @@ public class ListingWs implements WebService {
           handleResponseExample(action, response);
         }
       });
-    action.createParam("controller").setRequired(true);
-    action.createParam("action").setRequired(true);
+    action.createParam("controller")
+      .setRequired(true)
+      .setDescription("Controller of the web service")
+      .setExampleValue("api/issues");
+    action.createParam("action")
+      .setRequired(true)
+      .setDescription("Action of the web service")
+      .setExampleValue("search");
   }
 
   private void handleResponseExample(Action action, Response response) throws IOException {

diff --git a/sonar-server/src/test/java/org/sonar/server/component/ws/ResourcesWsTest.java b/sonar-server/src/test/java/org/sonar/server/component/ws/ResourcesWsTest.java
index 8609d26d1d54eabae5cc22723f0291b064dfc731..71eb9571db3c56cec668d731037113b539d529e7 100644 (file)
--- a/sonar-server/src/test/java/org/sonar/server/component/ws/ResourcesWsTest.java
+++ b/sonar-server/src/test/java/org/sonar/server/component/ws/ResourcesWsTest.java
@@ -42,7 +42,7 @@ public class ResourcesWsTest {
   public void define_controller() throws Exception {
     assertThat(controller).isNotNull();
     assertThat(controller.since()).isEqualTo("2.10");
-    assertThat(controller.description()).isNull();
+    assertThat(controller.description()).isNotEmpty();
     assertThat(controller.actions()).hasSize(2);
   }
 

diff --git a/sonar-server/src/test/java/org/sonar/server/measure/ws/TimeMachineWsTest.java b/sonar-server/src/test/java/org/sonar/server/measure/ws/TimeMachineWsTest.java
index 74766ad2a2c20c9fb0e4100ec55acb7d47382942..2b8b1df091d5647e65cd296ba86b08f7946e0c10 100644 (file)
--- a/sonar-server/src/test/java/org/sonar/server/measure/ws/TimeMachineWsTest.java
+++ b/sonar-server/src/test/java/org/sonar/server/measure/ws/TimeMachineWsTest.java
@@ -42,7 +42,7 @@ public class TimeMachineWsTest {
   public void define_controller() throws Exception {
     assertThat(controller).isNotNull();
     assertThat(controller.since()).isEqualTo("2.10");
-    assertThat(controller.description()).isNull();
+    assertThat(controller.description()).isNotEmpty();
     assertThat(controller.actions()).hasSize(1);
   }
 

diff --git a/sonar-server/src/test/java/org/sonar/server/platform/ws/ServerWsTest.java b/sonar-server/src/test/java/org/sonar/server/platform/ws/ServerWsTest.java
index 02646e63d2e8baf2effde8bca3e22a2c0ae81d2b..6042f2aed651814a5efbc6de86bdc722fb7df99f 100644 (file)
--- a/sonar-server/src/test/java/org/sonar/server/platform/ws/ServerWsTest.java
+++ b/sonar-server/src/test/java/org/sonar/server/platform/ws/ServerWsTest.java
@@ -42,7 +42,7 @@ public class ServerWsTest {
     WebService.Controller controller = tester.controller("api/server");
     assertThat(controller).isNotNull();
     assertThat(controller.since()).isEqualTo("2.10");
-    assertThat(controller.description()).isNull();
+    assertThat(controller.description()).isNotEmpty();
     assertThat(controller.actions()).hasSize(2);
   }
 

diff --git a/sonar-server/src/test/java/org/sonar/server/platform/ws/SystemWsTest.java b/sonar-server/src/test/java/org/sonar/server/platform/ws/SystemWsTest.java
index dd7b6e0c712001188871fc0a157779312ee9be8d..8c4ad6475205d4093ce01ccdb16bdc21ac13b4df 100644 (file)
--- a/sonar-server/src/test/java/org/sonar/server/platform/ws/SystemWsTest.java
+++ b/sonar-server/src/test/java/org/sonar/server/platform/ws/SystemWsTest.java
@@ -42,6 +42,8 @@ public class SystemWsTest {
 
     assertThat(context.controllers()).hasSize(1);
     assertThat(context.controller("api/system")).isNotNull();
+    assertThat(context.controller("api/system").description()).isNotEmpty();
+    assertThat(context.controller("api/system").since()).isEqualTo("4.3");
     assertThat(context.controller("api/system").actions()).isNotEmpty();
   }
 }

diff --git a/sonar-server/src/test/java/org/sonar/server/rule/ws/RuleTagsWsTest.java b/sonar-server/src/test/java/org/sonar/server/rule/ws/RuleTagsWsTest.java
index c94545c841d57245353ff68701168b22d4080003..2981115d70ccdd885c88311ba6c70fb815d32984 100644 (file)
--- a/sonar-server/src/test/java/org/sonar/server/rule/ws/RuleTagsWsTest.java
+++ b/sonar-server/src/test/java/org/sonar/server/rule/ws/RuleTagsWsTest.java
@@ -26,9 +26,9 @@ import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 import org.sonar.api.server.ws.WebService;
-import org.sonar.server.ws.WsTester;
 import org.sonar.core.rule.RuleTagDto;
 import org.sonar.server.rule.RuleTags;
+import org.sonar.server.ws.WsTester;
 
 import static org.fest.assertions.Assertions.assertThat;
 import static org.fest.assertions.Fail.fail;
@@ -53,6 +53,7 @@ public class RuleTagsWsTest {
     assertThat(controller).isNotNull();
     assertThat(controller.path()).isEqualTo("api/rule_tags");
     assertThat(controller.description()).isNotEmpty();
+    assertThat(controller.actions()).hasSize(2);
 
     WebService.Action search = controller.action("list");
     assertThat(search).isNotNull();

diff --git a/sonar-server/src/test/java/org/sonar/server/source/ws/SourcesWsTest.java b/sonar-server/src/test/java/org/sonar/server/source/ws/SourcesWsTest.java
index 1a480af5e23625b7490d560976b802c016166808..32c78261dfdf266fa28398d862cf44733be5f1a1 100644 (file)
--- a/sonar-server/src/test/java/org/sonar/server/source/ws/SourcesWsTest.java
+++ b/sonar-server/src/test/java/org/sonar/server/source/ws/SourcesWsTest.java
@@ -38,7 +38,8 @@ public class SourcesWsTest {
   public void define_ws() throws Exception {
     WebService.Controller controller = tester.controller("api/sources");
     assertThat(controller).isNotNull();
-    assertThat(controller.description()).isNull();
+    assertThat(controller.since()).isEqualTo("4.2");
+    assertThat(controller.description()).isNotEmpty();
 
     WebService.Action show = controller.action("show");
     assertThat(show).isNotNull();

diff --git a/sonar-server/src/test/java/org/sonar/server/updatecenter/ws/UpdateCenterWsTest.java b/sonar-server/src/test/java/org/sonar/server/updatecenter/ws/UpdateCenterWsTest.java
index cf10851be779f524bf7c1c12b43b90e781c1386a..ad6dd204ca75fdd535397d75b8a14ac0c268ce1e 100644 (file)
--- a/sonar-server/src/test/java/org/sonar/server/updatecenter/ws/UpdateCenterWsTest.java
+++ b/sonar-server/src/test/java/org/sonar/server/updatecenter/ws/UpdateCenterWsTest.java
@@ -42,7 +42,7 @@ public class UpdateCenterWsTest {
     WebService.Controller controller = tester.controller("api/updatecenter");
     assertThat(controller).isNotNull();
     assertThat(controller.since()).isEqualTo("2.10");
-    assertThat(controller.description()).isNull();
+    assertThat(controller.description()).isNotEmpty();
     assertThat(controller.actions()).hasSize(1);
   }
 

diff --git a/sonar-server/src/test/java/org/sonar/server/ws/ListingWsTest.java b/sonar-server/src/test/java/org/sonar/server/ws/ListingWsTest.java
index e21904299d3bdac2ecb513cfbf23375e9c36dcdd..9df9a5f17729f27ce0d844933ca4287dd8f095b9 100644 (file)
--- a/sonar-server/src/test/java/org/sonar/server/ws/ListingWsTest.java
+++ b/sonar-server/src/test/java/org/sonar/server/ws/ListingWsTest.java
@@ -38,6 +38,7 @@ public class ListingWsTest {
     WebService.Controller controller = tester.controller("api/webservices");
     assertThat(controller).isNotNull();
     assertThat(controller.path()).isEqualTo("api/webservices");
+    assertThat(controller.since()).isEqualTo("4.2");
     assertThat(controller.description()).isNotEmpty();
     assertThat(controller.actions()).hasSize(2);
 

diff --git a/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list.json b/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list.json
index ce70fc276c6472252efad03c6c8ac2a533cd08e1..57e04225bd0f08691b58124e80c1ba9a2c4eeed1 100644 (file)
--- a/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list.json
+++ b/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list.json
@@ -38,10 +38,12 @@
   {
     "path": "api/webservices",
     "description": "List web services",
+    "since": "4.2",
     "actions": [
       {
         "key": "list",
         "since": "4.2",
+        "description": "List web services",
         "internal": false,
         "post": false,
         "hasResponseExample": false,
@@ -57,17 +59,23 @@
       },
       {
         "key": "response_example",
+        "since": "4.4",
+        "description": "Display web service response example",
         "internal": false,
         "post": false,
         "hasResponseExample": false,
         "params": [
           {
             "key": "action",
-            "required": true
+            "required": true,
+            "description": "Action of the web service",
+            "exampleValue": "search"
           },
           {
             "key": "controller",
-            "required": true
+            "required": true,
+            "description": "Controller of the web service",
+            "exampleValue": "api/issues"
           }
         ]
       }

diff --git a/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list_including_internals.json b/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list_including_internals.json
index 82631afb3b43414cad771602e3367612b377b1dc..97fa53f6b5bbd308acec477c49739c3739e81e70 100644 (file)
--- a/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list_including_internals.json
+++ b/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list_including_internals.json
@@ -45,10 +45,12 @@
   {
     "path": "api/webservices",
     "description": "List web services",
+    "since": "4.2",
     "actions": [
       {
         "key": "list",
         "since": "4.2",
+        "description": "List web services",
         "internal": false,
         "post": false,
         "hasResponseExample": false,
@@ -64,17 +66,23 @@
       },
       {
         "key": "response_example",
+        "since": "4.4",
+        "description": "Display web service response example",
         "internal": false,
         "post": false,
         "hasResponseExample": false,
         "params": [
           {
             "key": "action",
-            "required": true
+            "required": true,
+            "description": "Action of the web service",
+            "exampleValue": "search"
           },
           {
             "key": "controller",
-            "required": true
+            "required": true,
+            "description": "Controller of the web service",
+            "exampleValue": "api/issues"
           }
         ]
       }