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

docs: document "complete" field for "notifiy_update_response" 

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2020-12-17 17:58:04 -05:00
parent cdbaaedc8a
commit 653c9190c4
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/web_api.md
View File

@ -1159,7 +1159,8 @@ Where `response` is an object int he following format:
{ {
application: <string>, application: <string>,
proc_id: <int>, proc_id: <int>,
message: <string> message: <string>,
complete: <boolean>
} }
``` ```
- The `application` field contains the name of application currently being - The `application` field contains the name of application currently being
@ -1169,6 +1170,9 @@ Where `response` is an object int he following format:
process. This id is generated for each update request. process. This id is generated for each update request.
- The `message` field contains an asyncronous message sent during the update - The `message` field contains an asyncronous message sent during the update
process. process.
- The `complete` field is set to true on the final message sent during an
update, indicating that the update completed successfully. Otherwise it
will be false.
# Appendix # Appendix