From 653c9190c44f52779b9f76f347e6391f253f78af Mon Sep 17 00:00:00 2001
From: Arksine <arksine.code@gmail.com>
Date: Thu, 17 Dec 2020 17:58:04 -0500
Subject: [PATCH] docs:  document "complete" field for
 "notifiy_update_response"

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
---
 docs/web_api.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/docs/web_api.md b/docs/web_api.md
index 677e99d..e4503a8 100644
--- a/docs/web_api.md
+++ b/docs/web_api.md
@@ -1159,7 +1159,8 @@ Where `response` is an object int he following format:
 {
     application: <string>,
     proc_id: <int>,
-    message: <string>
+    message: <string>,
+    complete: <boolean>
 }
 ```
 - 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.
 - The `message` field contains an asyncronous message sent during the update
   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