3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add the "jump queue" API 

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2022-12-22 14:09:15 -05:00
parent 129b0feb81
commit f7d8af6e12
No known key found for this signature in database
GPG Key ID: 5A1EB336DFB4C71B
1 changed files with 50 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/web_api.md
View File

@ -2866,6 +2866,56 @@ The current state of the job queue:
}
```
#### Perform a Queue Jump
Jumps a job to the front of the queue.
HTTP request:
```http
POST /server/job_queue/jump?job_id=0000000066D991F0
```
JSON-RPC request:
```json
{
"jsonrpc": "2.0",
"method": "server.job_queue.jump",
"params" {
"job_id": "0000000066D991F0"
},
"id": 4654
}
```
Returns:
The current state of the job queue:
```json
{
"queued_jobs": [
{
"filename": "job2.gcode",
"job_id": "0000000066D991F0",
"time_added": 1636151050.7766452,
"time_in_queue": 21.88680004119873
},
{
"filename": "job1.gcode",
"job_id": "0000000066D99C90",
"time_added": 1636151050.7666452,
"time_in_queue": 21.89680004119873
},
{
"filename": "subdir/job3.gcode",
"job_id": "0000000066D99D80",
"time_added": 1636151050.7866452,
"time_in_queue": 21.90680004119873
}
],
"queue_state": "loading"
}
```
### Announcement APIs
The following endpoints are available to manage announcements. See
[the appendix](#announcements) for details on how