about summary refs log tree commit diff
diff options
context:
space:
mode:
authorfranck cuny <franck@lumberjaph.net>2010-04-14 10:59:43 +0200
committerfranck cuny <franck@lumberjaph.net>2010-04-14 10:59:43 +0200
commit0e6e55c668ba7473de2cc719460997681515f94f (patch)
treecae7e0c44c1e5629cabaf607ea2984e3faf41c5a
parentadd deps to makefile (diff)
downloadpresque-0e6e55c668ba7473de2cc719460997681515f94f.tar.gz
add more POD
-rw-r--r--lib/presque.pm28
1 files changed, 16 insertions, 12 deletions
diff --git a/lib/presque.pm b/lib/presque.pm
index f64800a..a1b7cbd 100644
--- a/lib/presque.pm
+++ b/lib/presque.pm
@@ -66,31 +66,27 @@ The following HTTP routes are available:
 
 =over 4
 
-=item
-
-    GET /q/queuename
+=item B<GET /q/queuename>
 
 gets an object out of the queue
 
-=item
-
-    POST /q/queuename
+=item B<POST /q/queuename>
 
 insert an object in the queue
 
-=item
-
-    DELETE /q/queuename
+=item B<DELETE /q/queuename>
 
 purge and delete the queue
 
-=item
-
-    GET /stats/[queuename]
+=item B<GET /stats/[queuename]>
 
 return some statues about the queue. If no queue is given, return basic statues about
 all the queues.
 
+=item B<GET /j/queuename>
+
+return some basic information about a queue.
+
 =back
 
 =head2 INSERT A JOB
@@ -102,6 +98,14 @@ must be a valid JSON object.
 
 =head2 FETCH A JOB
 
+Return a JSON object
+
+   curl http://localhost:5002/q/foo
+
+=head2 PURGE AND DELETE A QUEUE
+
+   curl -X DELETE http://localhost:5002/q/foo
+
 =head1 AUTHOR
 
 franck cuny E<lt>franck@lumberjaph.netE<gt>