[lxc-devel] [lxd/master] Update /operations endpoint API doc

[j8r on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 382 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20191220/20b40fc9/attachment.bin>
-------------- next part --------------
From c261eaaff9140148af6af1c200a916d1017c327c Mon Sep 17 00:00:00 2001
From: Julien Reichardt <git at jrei.ch>
Date: Fri, 20 Dec 2019 12:29:14 +0100
Subject: [PATCH] Update /operations endpoint API doc

---
 doc/rest-api.md | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/doc/rest-api.md b/doc/rest-api.md
index 0d21286740..ba65997fc2 100644
--- a/doc/rest-api.md
+++ b/doc/rest-api.md
@@ -2042,14 +2042,17 @@ Return:
  * Description: list of operations
  * Authentication: trusted
  * Operation: sync
- * Return: list of URLs for operations that are currently going on/queued
+ * Return: dict representing a list of URLs for operations that are currently going on/queued according to their status
 
 Return:
-
-    [
-        "/1.0/operations/c0fc0d0d-a997-462b-842b-f8bd0df82507",
-        "/1.0/operations/092a8755-fd90-4ce4-bf91-9f87d03fd5bc"
-    ]
+    {
+        "success": [
+            "/1.0/operations/c0fc0d0d-a997-462b-842b-f8bd0df82507"
+        ],
+        "running": [
+            "/1.0/operations/092a8755-fd90-4ce4-bf91-9f87d03fd5bc"
+        ]
+    }
 
 ### `/1.0/operations/<uuid>`
 #### GET