From 439138ce492ba0210ffba7d1fe96c59827f79a2c Mon Sep 17 00:00:00 2001 From: Julien Lancelot Date: Tue, 29 Apr 2014 17:22:22 +0200 Subject: [PATCH] SONAR-5111 Complete "api/issue_filters" WS doc --- .../server/issue/filter/IssueFilterWs.java | 8 ++-- .../issue/filter/IssueFilterWsTest.java | 40 ++++++++++++++++--- 2 files changed, 39 insertions(+), 9 deletions(-) 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 1dba5114c55..04dc4068583 100644 --- 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 8757a9855a2..3eb495bbb7f 100644 --- 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 -- 2.39.5