Skip to content

Commit

Permalink
Add some extra docs in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ianmcorvidae committed May 15, 2018
1 parent 3057b6a commit f25043c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ job-status-listener

Listens over HTTP for job status updates, then publishes them to AMQP.

Details TBD.
This service accepts a JSON request body at the `POST {uuid}/status` endpoint which describes a status update for the job with an external ID of `{uuid}`. The body should have three keys, all strings: hostname, message, and state, where state should be one of: submitted, running, completed, or failed. More documentation for the public-facing part of this is available at https://cyverse-de.github.io/misc-api/ .

0 comments on commit f25043c

Please sign in to comment.