From baffce720b0cccd74283f232d1d9bcfb303979ac Mon Sep 17 00:00:00 2001 From: Michael Plainer Date: Tue, 15 May 2018 17:08:45 +0200 Subject: [PATCH] Add missing JSON API requests to Readme.md Changing the state and priority is not described in the readme, however all other methods are. --- Readme.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index 5c8afe1e..f3a16aa0 100644 --- a/Readme.md +++ b/Readme.md @@ -677,7 +677,7 @@ You can also use [Kue-UI](https://github.com/StreetHub/kue-ui) web interface con ## JSON API -Along with the UI Kue also exposes a JSON API, which is utilized by the UI. +Along with the UI Kue also exposes a JSON API, which is utilized by the UI. The UI server has to be queried. ### GET /job/search?q= @@ -757,6 +757,19 @@ Same as above, restricting by `:state` which is one of: Same as above, however restricted to `:type` and `:state`. +### PUT /job/:id/state/:state + +Change the state of a given `:job`. `:state` can be one of: + + - active + - inactive + - failed + - complete + +### PUT /job/:id/priority/:priority + +Change the priority of a given `:job`. `:priority` is a numerical value (integer). + ### DELETE /job/:id Delete job `:id`: