From a3cd6c01d0ccd5a5b284dfb36fa9a1456bea5083 Mon Sep 17 00:00:00 2001 From: Simon Brandhof Date: Fri, 2 Oct 2015 11:57:51 +0200 Subject: [PATCH] Improve doc of api/ce/queue --- .../java/org/sonar/server/computation/ws/QueueWsAction.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) 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 -- 2.39.5