SONAR-5111 Complete "api/issue_filters" WS doc

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 1dba5114c55e53db9d934eed7c6fdda7554abca2..04dc4068583af57f67a74d309b37e2a53f860953 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
@@ -60,15 +60,17 @@ public class IssueFilterWs implements WebService {
 
     NewAction show = controller.createAction("show");
     show
-      .setDescription("Get detail of issue filter")
+      .setDescription("Get detail of an issue filter. Requires to be authenticated")
       .setSince("4.2")
       .setHandler(new RequestHandler() {
         @Override
         public void handle(Request request, Response response) {
           show(request, response);
         }
-      })
-      .createParam(PARAM_ID).setRequired(true);
+      });
+    show.createParam(PARAM_ID)
+      .setDescription("ID of the issue filter")
+      .setRequired(true);
 
     NewAction fav = controller.createAction("favorites");
     fav

diff --git a/sonar-server/src/test/java/org/sonar/server/issue/filter/IssueFilterWsTest.java b/sonar-server/src/test/java/org/sonar/server/issue/filter/IssueFilterWsTest.java
index 8757a9855a2837c283ad2f6ecd7c281c483e904d..3eb495bbb7fbb20f6d44cd5705a4cd14668b8c53 100644 (file)
--- a/sonar-server/src/test/java/org/sonar/server/issue/filter/IssueFilterWsTest.java
+++ b/sonar-server/src/test/java/org/sonar/server/issue/filter/IssueFilterWsTest.java
@@ -21,10 +21,10 @@ package org.sonar.server.issue.filter;
 
 import org.junit.Test;
 import org.sonar.api.server.ws.WebService;
-import org.sonar.server.ws.WsTester;
 import org.sonar.core.issue.DefaultIssueFilter;
 import org.sonar.server.exceptions.NotFoundException;
 import org.sonar.server.user.MockUserSession;
+import org.sonar.server.ws.WsTester;
 
 import java.util.Arrays;
 
@@ -46,11 +46,39 @@ public class IssueFilterWsTest {
     assertThat(controller.description()).isNotEmpty();
     assertThat(controller.since()).isEqualTo("4.2");
 
-    WebService.Action index = controller.action("app");
-    assertThat(index).isNotNull();
-    assertThat(index.handler()).isNotNull();
-    assertThat(index.isPost()).isFalse();
-    assertThat(index.isInternal()).isTrue();
+    WebService.Action app = controller.action("app");
+    assertThat(app).isNotNull();
+    assertThat(app.handler()).isNotNull();
+    assertThat(app.isPost()).isFalse();
+    assertThat(app.isInternal()).isTrue();
+    assertThat(app.since()).isEqualTo("4.2");
+    assertThat(app.params()).hasSize(1);
+
+    WebService.Param appId = app.param("id");
+    assertThat(appId).isNotNull();
+    assertThat(appId.description()).isNotNull();
+    assertThat(appId.isRequired()).isFalse();
+
+    WebService.Action show = controller.action("show");
+    assertThat(show).isNotNull();
+    assertThat(show.handler()).isNotNull();
+    assertThat(show.isPost()).isFalse();
+    assertThat(show.isInternal()).isFalse();
+    assertThat(show.since()).isEqualTo("4.2");
+    assertThat(show.params()).hasSize(1);
+
+    WebService.Param showId = show.param("id");
+    assertThat(showId).isNotNull();
+    assertThat(showId.description()).isNotNull();
+    assertThat(showId.isRequired()).isTrue();
+
+    WebService.Action favorites = controller.action("favorites");
+    assertThat(favorites).isNotNull();
+    assertThat(favorites.handler()).isNotNull();
+    assertThat(favorites.isPost()).isFalse();
+    assertThat(favorites.isInternal()).isFalse();
+    assertThat(favorites.since()).isEqualTo("4.2");
+    assertThat(favorites.params()).isEmpty();
   }
 
   @Test