diff options
| author | Christoph Helma <helma@in-silico.ch> | 2011-03-11 14:29:07 +0100 |
|---|---|---|
| committer | Christoph Helma <helma@in-silico.ch> | 2011-03-11 14:29:07 +0100 |
| commit | 7160c18e3b479b5020a79853bc575a82a607f28c (patch) | |
| tree | 155078e60030f917750e855f699da82ee437adcd | |
| parent | a8bcd368193d82f5d8fc0eb7140d2d104b566e02 (diff) | |
| parent | a84cf271891774513cef857a3c15648768b0b803 (diff) | |
Merge branch 'release/v1.0.1'v1.0.1
| -rw-r--r-- | .yardopts | 1 | ||||
| -rw-r--r-- | README | 29 | ||||
| -rw-r--r-- | README.md | 26 |
3 files changed, 27 insertions, 29 deletions
diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..c1a7ad0 --- /dev/null +++ b/.yardopts @@ -0,0 +1 @@ +application.rb @@ -1,29 +0,0 @@ -OpenTox Task -============ - -* An OpenTox REST Webservice (http://www.opentox.org) -* Does _not_ comply to the (incomplete) OpenTox API - -REST operations ---------------- - -Get a list of all tasks GET / - Task URIs 200 -Get the status of a task GET /{id}/status - created|started|completed|cancelled 200,404 -Get the PID of a task GET /{id}/pid - Task PID 200,404 -Create a new task POST / - Task URI 200 -Start a task PUT /{id}/started "" - 200,404 -Complete a task PUT /{id}/completed resource={resource_uri} - 200,404 -Set the PID of a task PUT /{id}/pid pid={PID} - 200,404 -Cancel a task PUT /{id}/cancelled "" - 200, 404 -Delete a task DELETE /{id} - - 200, 404 -Delete all tasks DELETE / - - 200 - -IMPORTANT NOTE: Our framework does not accept empty PUT requests. Please send an empty parameter (e.g. with -d '' for curl) or you will receive a "411 Length Required" error. - -API documentation ------------------ - -http://rdoc.info/github/opentox/task - -Copyright (c) 2009-2011 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. - diff --git a/README.md b/README.md new file mode 100644 index 0000000..a892d04 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +OpenTox Task +============ + +- An [OpenTox](http://www.opentox.org) REST Webservice + +REST operations +--------------- + + Get a list of all tasks GET / - Task URIs 200 + Get the status of a task GET /{id}/status - created|started|completed|cancelled 200,404 + Get the PID of a task GET /{id}/pid - Task PID 200,404 + Create a new task POST / - Task URI 200 + Start a task PUT /{id}/started "" - 200,404 + Complete a task PUT /{id}/completed resource={resource_uri} - 200,404 + Set the PID of a task PUT /{id}/pid pid={PID} - 200,404 + Cancel a task PUT /{id}/cancelled "" - 200, 404 + Delete a task DELETE /{id} - - 200, 404 + Delete all tasks DELETE / - - 200 + +IMPORTANT NOTE: Our framework does not accept empty PUT requests. Please send an empty parameter (e.g. with -d '' for curl) or you will receive a "411 Length Required" error. + +[API documentation](http://rdoc.info/github/opentox/task) +-------------------------------------------------------- + +Copyright (c) 2009-2011 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. + |