SONAR-5111 Use latest API to declare batch WS metadata, update Javadoc

example, add response example for batch WS

2 files changed, 6 insertions, 2 deletions

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 25c4cc91746..228c36581fa 100644
--- a/sonar-server/src/main/java/org/sonar/server/plugins/BatchWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/plugins/BatchWs.java
@@ -82,7 +82,7 @@ public class BatchWs implements WebService, Startable {
         public void handle(Request request, Response response) {
           index(response);
         }
-      });
+      }).setResponseExample(getClass().getResource("example-batch-index.txt"));
     controller.createAction("file")
       .setInternal(true)
       .setDescription("Download a JAR file required by source analyzer")
@@ -91,7 +91,9 @@ public class BatchWs implements WebService, Startable {
         public void handle(Request request, Response response) {
           file(request, response);
         }
-      }).createParam("name", "Filename");
+      }).createParam("name")
+        .setDescription("File name")
+        .setExampleValue("batch-library-2.3.jar");
 
     controller.done();
   }
diff --git a/sonar-server/src/main/resources/org/sonar/server/plugins/example-batch-index.txt b/sonar-server/src/main/resources/org/sonar/server/plugins/example-batch-index.txt
new file mode 100644
index 00000000000..5ab3dc81d02
--- /dev/null
+++ b/sonar-server/src/main/resources/org/sonar/server/plugins/example-batch-index.txt
@@ -0,0 +1,2 @@
+sonar-batch-maven-compat-4.4.jar|2d7cbec208114970ea419ce963775f68
+sonar-batch-library-2.3.jar|86f577369ec914ae079411803cebc7d2