Add some description of the result array for Ws using compressed format

diff --git a/sonar-server/src/main/java/org/sonar/server/source/ws/ScmAction.java b/sonar-server/src/main/java/org/sonar/server/source/ws/ScmAction.java
index bfc688bb4111a7bee3620da3ffad0ec99a2fe466..8f67df2342d97570c707cfdada4f67658da6a560 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/source/ws/ScmAction.java
+++ b/sonar-server/src/main/java/org/sonar/server/source/ws/ScmAction.java
@@ -40,7 +40,13 @@ public class ScmAction implements RequestHandler {
 
   void define(WebService.NewController controller) {
     WebService.NewAction action = controller.createAction("scm")
-      .setDescription("Get SCM information of source files. Require Browse permission on file's project")
+      .setDescription("Get SCM information of source files. Require Browse permission on file's project<br/>" +
+        "Each element of the result array is composed of:" +
+        "<ol>" +
+        "<li>Line number</li>" +
+        "<li>Author of the commit</li>" +
+        "<li>Date of the commit</li>" +
+        "</ol>")
       .setSince("4.4")
       .setResponseExample(Resources.getResource(getClass(), "example-scm.json"))
       .setHandler(this);

diff --git a/sonar-server/src/main/java/org/sonar/server/source/ws/ShowAction.java b/sonar-server/src/main/java/org/sonar/server/source/ws/ShowAction.java
index bf90536acd96b900eb7a25f7fa2f76407a266179..b3947c65ef53224647c51cef031d461b4702a65f 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/source/ws/ShowAction.java
+++ b/sonar-server/src/main/java/org/sonar/server/source/ws/ShowAction.java
@@ -41,7 +41,12 @@ public class ShowAction implements RequestHandler {
 
   void define(WebService.NewController controller) {
     WebService.NewAction action = controller.createAction("show")
-      .setDescription("Get source code. Require Browse permission on file's project")
+      .setDescription("Get source code. Require Browse permission on file's project<br/>" +
+        "Each element of the result array is composed of:" +
+        "<ol>" +
+        "<li>Line number</li>" +
+        "<li>Content of the line</li>" +
+        "</ol>")
       .setSince("4.4")
       .setResponseExample(Resources.getResource(getClass(), "example-show.json"))
       .setHandler(this);

diff --git a/sonar-server/src/main/java/org/sonar/server/test/ws/CoverageShowAction.java b/sonar-server/src/main/java/org/sonar/server/test/ws/CoverageShowAction.java
index e385920a9277aab788747bd58b3a53e37be842b4..41ce23f4b5dae94898f941636b7f50e8ab810923 100644 (file)
--- a/sonar-server/src/main/java/org/sonar/server/test/ws/CoverageShowAction.java
+++ b/sonar-server/src/main/java/org/sonar/server/test/ws/CoverageShowAction.java
@@ -46,7 +46,14 @@ public class CoverageShowAction implements RequestHandler {
 
   void define(WebService.NewController controller) {
     WebService.NewAction action = controller.createAction("show")
-      .setDescription("Get code coverage. Require Browse permission on file's project")
+      .setDescription("Get code coverage. Require Browse permission on file's project<br/>" +
+        "Each element of the result array is composed of:" +
+        "<ol>" +
+        "<li>Line number</li>" +
+        "<li>Is the line covered?</li>" +
+        "<li>Number of branches</li>" +
+        "<li>Number of branches covered</li>" +
+        "</ol>")
       .setSince("4.4")
       .setResponseExample(Resources.getResource(getClass(), "coverage-example-show.json"))
       .setHandler(this);