about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorfranck cuny <franck@lumberjaph.net>2010-06-28 17:40:14 +0200
committerfranck cuny <franck@lumberjaph.net>2010-06-28 17:40:14 +0200
commit0d5bf96d9dfa6a976876818d8aeabacb7e789a3d (patch)
treee3d8192b22127c23dcb2975db4f67e7636b393de /docs
parentupdate POD (diff)
downloadpresque-0d5bf96d9dfa6a976876818d8aeabacb7e789a3d.tar.gz
add docs dir.
Diffstat (limited to 'docs')
-rw-r--r--docs/ROUTES37
-rw-r--r--docs/TODO4
2 files changed, 41 insertions, 0 deletions
diff --git a/docs/ROUTES b/docs/ROUTES
new file mode 100644
index 0000000..1dff148
--- /dev/null
+++ b/docs/ROUTES
@@ -0,0 +1,37 @@
+#+TITLE: PRESQUE ROUTES
+
+** GET /
+   "dashboard"
+
+** GET /q/:queue_name?worker_id
+   fetch a job from a queue
+
+** DELETE /q/:queue_name
+   delete a queue
+
+** POST /q/:queue_name
+   create a new job
+
+** PUT /q/:queue_name
+   mark a job as failed
+
+** GET /j/:queue_name
+   get some stats about a queue
+
+** GET /w/
+   get some stats for a queue
+
+** POST /w/:queue_name
+   register a worker on a queue
+
+** DELETE /w/:queue_name
+   unregister a worker on a queue
+
+** GET /status/:queue_name
+   get the size of a queue
+
+** GET /control/:queue_name
+   is the queue open or closed ?
+
+** POST /control/:queue_name
+   close or open a queue
diff --git a/docs/TODO b/docs/TODO
new file mode 100644
index 0000000..76afe22
--- /dev/null
+++ b/docs/TODO
@@ -0,0 +1,4 @@
+* web interface to monitor/post jobs
+* websocket ?
+* xmpp ?
+* priorities ?