From: Simon Brandhof <simon.brandhof@sonarsource.com>
Date: Fri, 2 Oct 2015 09:57:51 +0000 (+0200)
Subject: Improve doc of api/ce/queue
X-Git-Tag: 5.2-RC1~110
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=a3cd6c01d0ccd5a5b284dfb36fa9a1456bea5083;p=sonarqube.git

Improve doc of api/ce/queue
---

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