diff options
| author | Simon Brandhof <simon.brandhof@sonarsource.com> | 2015-10-02 11:57:51 +0200 |
|---|---|---|
| committer | Simon Brandhof <simon.brandhof@sonarsource.com> | 2015-10-02 11:57:51 +0200 |
| commit | a3cd6c01d0ccd5a5b284dfb36fa9a1456bea5083 (patch) | |
| tree | d596a3cb6a1c13da4a24111cb10fe50fcbf10eb4 | |
| parent | 29eab470eb9886f3474d724a0c2f7dcdc7c2d5d1 (diff) | |
| download | sonarqube-a3cd6c01d0ccd5a5b284dfb36fa9a1456bea5083.tar.gz sonarqube-a3cd6c01d0ccd5a5b284dfb36fa9a1456bea5083.zip | |
Improve doc of api/ce/queue
| -rw-r--r-- | server/sonar-server/src/main/java/org/sonar/server/computation/ws/QueueWsAction.java | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/server/sonar-server/src/main/java/org/sonar/server/computation/ws/QueueWsAction.java b/server/sonar-server/src/main/java/org/sonar/server/computation/ws/QueueWsAction.java index 2a1a63d7443..4ee9655589a 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/computation/ws/QueueWsAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/computation/ws/QueueWsAction.java @@ -25,6 +25,7 @@ import org.sonar.api.server.ws.Response; import org.sonar.api.server.ws.WebService; import org.sonar.api.web.UserRole; import org.sonar.core.permission.GlobalPermissions; +import org.sonar.core.util.Uuids; import org.sonar.db.DbClient; import org.sonar.db.DbSession; import org.sonar.db.ce.CeQueueDto; @@ -56,7 +57,10 @@ public class QueueWsAction implements CeWsAction { .setResponseExample(getClass().getResource("queue-example.json")) .setHandler(this); - action.createParam(PARAM_COMPONENT_UUID); + action + .createParam(PARAM_COMPONENT_UUID) + .setDescription("Optional filter on component. Requires administration permission of the component.") + .setExampleValue(Uuids.UUID_EXAMPLE_01); } @Override |