[lxc-devel] [lxd/master] doc: Add example of exec with record-output

[stgraber on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 370 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20180815/b913c211/attachment.bin>
-------------- next part --------------
From 915772166dffbca79c85e72f304db7070a2c5aac Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Graber?= <stgraber at ubuntu.com>
Date: Wed, 15 Aug 2018 14:18:32 -0400
Subject: [PATCH] doc: Add example of exec with record-output
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Closes #4922

Signed-off-by: Stéphane Graber <stgraber at ubuntu.com>
---
 doc/rest-api.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/rest-api.md b/doc/rest-api.md
index 5e69be365c..650baf84c9 100644
--- a/doc/rest-api.md
+++ b/doc/rest-api.md
@@ -892,6 +892,16 @@ Return (with wait-for-websocket=true and interactive=true):
         }
     }
 
+Return (with interactive=false and record-output=true):
+
+    {
+        "output": {
+            "1": "/1.0/containers/example/logs/exec_b0f737b4-2c8a-4edf-a7c1-4cc7e4e9e155.stdout",
+            "2": "/1.0/containers/example/logs/exec_b0f737b4-2c8a-4edf-a7c1-4cc7e4e9e155.stderr"
+        },
+        "return": 0
+    }
+
 When the exec command finishes, its exit status is available from the
 operation's metadata: