fffdac20c2
Some request details provided information about the other JSON value while others didn't. To make things consistent and to make sure API consumers understand how the requests need to be structured, this adds missing instances. It also reorders some parameter lists to be a little more logical, so even though we can't show the nested nature of some of these, it at least doesn't show inner values before outer ones. This also corrects many errors seen while going through the API ref. This is by no means exhaustive, and is already somewhat out of the scope for this patch, so it is expected that there are some (many) cases that are not addressed by this patch. Those will be fixed with ongoing effort in future patches. Partial-bug: #1713517 Change-Id: I30964ba8d829778fd01174d639d44ba07e4b77a6
182 lines
3.2 KiB
ReStructuredText
182 lines
3.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Consistency group snapshots
|
|
===========================
|
|
|
|
Lists all, lists all with details, shows details for, creates, and
|
|
deletes consistency group snapshots.
|
|
|
|
|
|
Delete a consistency group snapshot
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: DELETE /v3/{project_id}/cgsnapshots/{cgsnapshot_id}
|
|
|
|
Deletes a consistency group snapshot.
|
|
|
|
Normal response codes: 202
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- cgsnapshot_id: cgsnapshot_id_1
|
|
|
|
|
|
Show consistency group snapshot detail
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/cgsnapshots/{cgsnapshot_id}
|
|
|
|
Shows details for a consistency group snapshot.
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- cgsnapshot_id: cgsnapshot_id_1
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- cgsnapshot: cgsnapshot
|
|
- status: status
|
|
- description: description
|
|
- created_at: created_at
|
|
- consistencygroup_id: consistencygroup_id
|
|
- id: id
|
|
- name: name_2
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/cgsnapshots-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
List all consistency group snapshots with details
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/cgsnapshots/detail
|
|
|
|
Lists all consistency group snapshots with details.
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- cgsnapshots: cgsnapshots
|
|
- status: status
|
|
- description: description
|
|
- created_at: created_at
|
|
- consistencygroup_id: consistencygroup_id
|
|
- id: id
|
|
- name: name_2
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/cgsnapshots-list-detailed-response.json
|
|
:language: javascript
|
|
|
|
List all consistency group snapshots
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/cgsnapshots
|
|
|
|
Lists all consistency group snapshots.
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- cgsnapshots: cgsnapshots
|
|
- id: id
|
|
- name: name_2
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/cgsnapshots-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Create a consistency group snapshot
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: POST /v3/{project_id}/cgsnapshots
|
|
|
|
Creates a consistency group snapshot.
|
|
|
|
Normal response codes: 202
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- cgsnapshot: cgsnapshot
|
|
- name: name_5
|
|
- consistencygroup_id: consistencygroup_id
|
|
- description: description
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/cgsnapshots-create-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status
|
|
- description: description
|
|
- created_at: created_at
|
|
- consistencygroup_id: consistencygroup_id
|
|
- id: id
|
|
- name: name_2
|