The following pull request was submitted through Github. It can be accessed and reviewed at: https://github.com/lxc/lxd/pull/4284
This e-mail was sent by the LXC bot, direct replies will not reach the author unless they happen to be subscribed to this list. === Description (from pull-request) === Trivial fix adding some missing "Return:" headings to correctly format sample return content.
From 153c5c074447867ae68c42a9b2c677bbcafedc11 Mon Sep 17 00:00:00 2001 From: Alberto Donato <[email protected]> Date: Sun, 25 Feb 2018 13:31:52 +0100 Subject: [PATCH] Add some missing "Return:" headings to make sample return values formatting right --- doc/rest-api.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/rest-api.md b/doc/rest-api.md index e575cc3ac..7970a05eb 100644 --- a/doc/rest-api.md +++ b/doc/rest-api.md @@ -1755,6 +1755,8 @@ Input (none at present): * Operation: sync * Return: list of URLs for networks that are current defined on the host +Return: + [ "/1.0/networks/eth0", "/1.0/networks/lxdbr0" @@ -1786,6 +1788,8 @@ Input: * Operation: sync * Return: dict representing a network +Return: + { "config": {}, "name": "lxdbr0", @@ -1870,6 +1874,8 @@ HTTP code for this should be 202 (Accepted). * Operation: sync * Return: list of URLs for operations that are currently going on/queued +Return: + [ "/1.0/operations/c0fc0d0d-a997-462b-842b-f8bd0df82507", "/1.0/operations/092a8755-fd90-4ce4-bf91-9f87d03fd5bc" @@ -2086,6 +2092,8 @@ HTTP code for this should be 202 (Accepted). * Operation: sync * Return: list of storage pools that are currently defined on the host +Return: + [ "/1.0/storage-pools/default", "/1.0/storage-pools/pool1" @@ -2119,6 +2127,8 @@ Input: * Operation: sync * Return: dict representing a storage pool +Return: + { "type": "sync", "status": "Success", @@ -2217,6 +2227,8 @@ Input (none at present): * Operation: sync * Return: dict representing the storage pool resources +Return: + { "type": "sync", "status": "Success", @@ -2245,6 +2257,8 @@ Input (none at present): * Operation: sync * Return: list of storage volumes that currently exist on a given storage pool +Return: + [ "/1.0/storage-pools/default/volumes/containers/alp1", "/1.0/storage-pools/default/volumes/containers/alp10", @@ -2321,6 +2335,8 @@ Input: * Operation: sync * Return: dict representing a storage volume +Return: + { "type": "sync", "status": "Success", @@ -2397,6 +2413,8 @@ Input (none at present): * Operation: sync * Return: dict representing the system resources +Return: + { "type": "sync", "status": "Success",
_______________________________________________ lxc-devel mailing list [email protected] http://lists.linuxcontainers.org/listinfo/lxc-devel
