[lxc-devel] [lxd/master] fix API documentation formatting

[albertodonato on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 394 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20180225/34a011ba/attachment.bin>
-------------- next part --------------
From 153c5c074447867ae68c42a9b2c677bbcafedc11 Mon Sep 17 00:00:00 2001
From: Alberto Donato <alberto.donato at gmail.com>
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",