Add v2 v3 response example in API doc
In the api-ref/source/v2 and api-ref/source/v3, Add response example for some of volumes, backups, consistencygroups doc. Change-Id: I2d89df3cf6f691d6cde2429b1b33b5b16af3269c
This commit is contained in:
parent
c4580000d7
commit
04bfefcf34
@ -74,6 +74,12 @@ Request
|
|||||||
- volume_types: volume_types_2
|
- volume_types: volume_types_2
|
||||||
- name: name_15
|
- name: name_15
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/consistency-group-create-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
@ -87,12 +93,6 @@ Response
|
|||||||
- name: name_15
|
- name: name_15
|
||||||
- id: consistencygroup_id_1
|
- id: consistencygroup_id_1
|
||||||
|
|
||||||
Request Example
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. literalinclude:: ./samples/consistency-group-create-request.json
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
@ -207,6 +207,12 @@ Response Parameters
|
|||||||
- volume_id: volume_id
|
- volume_id: volume_id
|
||||||
- volume_name: volume_name
|
- volume_name: volume_name
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/backup-restore-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
Create backup
|
Create backup
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -223,9 +223,11 @@ Response Parameters
|
|||||||
- created_at: created_at
|
- created_at: created_at
|
||||||
- volume_type: volume_type
|
- volume_type: volume_type
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/volume-create-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
List volumes
|
List volumes
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
@ -207,6 +207,12 @@ Response Parameters
|
|||||||
- volume_id: volume_id
|
- volume_id: volume_id
|
||||||
- volume_name: volume_name
|
- volume_name: volume_name
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/backup-restore-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
Create a backup
|
Create a backup
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -191,6 +191,12 @@ Response Parameters
|
|||||||
- id: id
|
- id: id
|
||||||
- name: name
|
- name: name
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/group-snapshots-create-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Reset group snapshot status
|
Reset group snapshot status
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
{
|
{
|
||||||
"restore": {
|
"restore": {
|
||||||
"backup_id": "2ef47aee-8844-490c-804d-2a8efe561c65",
|
"backup_id": "2ef47aee-8844-490c-804d-2a8efe561c65",
|
||||||
"volume_id": "795114e8-7489-40be-a978-83797f2c1dd3"
|
"volume_id": "795114e8-7489-40be-a978-83797f2c1dd3",
|
||||||
|
"volume_name": "volume01",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,6 +1,11 @@
|
|||||||
{
|
{
|
||||||
"group_snapshot": {
|
"group_snapshot": {
|
||||||
"id": "6f519a48-3183-46cf-a32f-41815f816666",
|
"id": "6f519a48-3183-46cf-a32f-41815f816666",
|
||||||
"name": "first_group_snapshot"
|
"name": "first_group_snapshot",
|
||||||
|
"status": "creating",
|
||||||
|
"group_type_id": "58737af7-786b-48b7-ab7c-2447e74b0ef4",
|
||||||
|
"created_at": "2017-06-20T07:44:47.000000",
|
||||||
|
"group_id": "d5577983-23be-47e3-b98b-bf604e5af421",
|
||||||
|
"description": null
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -227,8 +227,11 @@ Response Parameters
|
|||||||
- created_at: created_at
|
- created_at: created_at
|
||||||
- volume_type: volume_type
|
- volume_type: volume_type
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/volume-create-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
List accessible volumes
|
List accessible volumes
|
||||||
|
Loading…
Reference in New Issue
Block a user