From bfbe8c51b7173aaff23b172d1fd3f2d7e882425d Mon Sep 17 00:00:00 2001
From: Michael Hanselmann <hansmi@google.com>
Date: Wed, 21 Nov 2012 06:14:32 +0100
Subject: [PATCH] RAPI: Clarify non-exhaustive nature of examples
The examples given in the RAPI documentation are not exhaustive. This
patch tries to clarify this by adding ellipses where appropriate. One
example's indentation is also fixed.
Signed-off-by: Michael Hanselmann <hansmi@google.com>
Reviewed-by: Guido Trotter <ultrotter@google.com>
---
doc/rapi.rst | 68 +++++++++++++++++++++++++++++-----------------------
1 file changed, 38 insertions(+), 30 deletions(-)
diff --git a/doc/rapi.rst b/doc/rapi.rst
index e8c391cfa..1e8d12a0f 100644
--- a/doc/rapi.rst
+++ b/doc/rapi.rst
@@ -368,8 +368,9 @@ Example::
"vcpus": 1,
"memory": 128
}
- }
- }
+ },
+ β¦
+ }
``/2/redistribute-config``
@@ -479,7 +480,8 @@ Example::
"node1.example.com",
"node2.example.com"
],
- "uuid": "0d7d407c-262e-49af-881a-6a430034bf43"
+ "uuid": "0d7d407c-262e-49af-881a-6a430034bf43",
+ β¦
},
{
"name": "group2",
@@ -487,8 +489,10 @@ Example::
"node_list": [
"node3.example.com"
],
- "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c"
- }
+ "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c",
+ β¦
+ },
+ β¦
]
``POST``
@@ -694,8 +698,10 @@ Example::
'network6': None,
'network_type': 'private',
'reserved_count': 3,
- 'tags': ['nfdhcpd']
+ 'tags': ['nfdhcpd'],
+ β¦
},
+ β¦
]
``POST``
@@ -901,29 +907,30 @@ Example::
[
{
- "status": "running",
- "disk_usage": 20480,
- "nic.bridges": [
- "xen-br0"
- ],
- "name": "web.example.com",
- "tags": ["tag1", "tag2"],
- "beparams": {
- "vcpus": 2,
- "memory": 512
- },
- "disk.sizes": [
- 20480
- ],
- "pnode": "node1.example.com",
- "nic.macs": ["01:23:45:67:89:01"],
- "snodes": ["node2.example.com"],
- "disk_template": "drbd",
- "admin_state": true,
- "os": "debian-etch",
- "oper_state": true
+ "status": "running",
+ "disk_usage": 20480,
+ "nic.bridges": [
+ "xen-br0"
+ ],
+ "name": "web.example.com",
+ "tags": ["tag1", "tag2"],
+ "beparams": {
+ "vcpus": 2,
+ "memory": 512
+ },
+ "disk.sizes": [
+ 20480
+ ],
+ "pnode": "node1.example.com",
+ "nic.macs": ["01:23:45:67:89:01"],
+ "snodes": ["node2.example.com"],
+ "disk_template": "drbd",
+ "admin_state": true,
+ "os": "debian-etch",
+ "oper_state": true,
+ β¦
},
- ...
+ β¦
]
@@ -1612,9 +1619,10 @@ Example::
"dtotal": 5246208,
"sinst_cnt": 2,
"dfree": 5171712,
- "offline": false
+ "offline": false,
+ β¦
},
- ...
+ β¦
]
``/2/nodes/[node_name]``
--
GitLab