openstack/cinder
Code Issues Proposed changes
5cafda7f40
cinder/api-ref/source/v3/group-snapshots.inc

290 lines
5.3 KiB
PHP
Raw Normal View History

Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
.. -*- rst -*-
Group snapshots
===============
Lists all, lists all with details, shows details for, creates, and
deletes group snapshots.
Delete group snapshot
Fix Block Storage API reference nesting Modifies heading levels in .inc files to allow nested display in table of contents. Table of contents depth has been changed to allow this. Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
2017-02-02 15:56:50 -06:00
~~~~~~~~~~~~~~~~~~~~~
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
[api-ref]Change tenant to project Keystone API v2 was deprecated in Mitaka and uses "project" instead of "tenant" in V3 now. This patch change the "tenant" to "project" in Cinder API v3 doc. Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
2017-01-09 11:51:06 +08:00
.. rest_method:: DELETE /v3/{project_id}/group_snapshots/{group_snapshot_id}
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Deletes a group snapshot.
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
Response codes
Fix api-ref response code title levels Using the wrong character resulted in the wrong title level being used for the response codes, which in turn caused the "detail" show/hide toggle to not be able to hide all of the per-endpoint details. This corrects these to be at the correct level. Also ran into issues after changing them where sphinx was not happy with the random title levels. This appears to be due to the order processed and whether not earlier included files had all subsequent levels. Adding an additional title in our first included file resolved that problem. Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03 Closes-bug: #1755566
2018-03-13 15:57:54 -05:00
--------------
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
.. rest_status_code:: success ../status.yaml
- 202
.. rest_status_code:: error ../status.yaml
- 400
- 404
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Request
-------
.. rest_parameters:: parameters.yaml
[api-ref]Change tenant to project Keystone API v2 was deprecated in Mitaka and uses "project" instead of "tenant" in V3 now. This patch change the "tenant" to "project" in Cinder API v3 doc. Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
2017-01-09 11:51:06 +08:00
- project_id: project_id_path
Improve/Clean api-ref parameters The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-10-30 11:03:09 +05:30
- group_snapshot_id: group_snapshot_id_path
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Show group snapshot details
Fix Block Storage API reference nesting Modifies heading levels in .inc files to allow nested display in table of contents. Table of contents depth has been changed to allow this. Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
2017-02-02 15:56:50 -06:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
[api-ref]Change tenant to project Keystone API v2 was deprecated in Mitaka and uses "project" instead of "tenant" in V3 now. This patch change the "tenant" to "project" in Cinder API v3 doc. Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
2017-01-09 11:51:06 +08:00
.. rest_method:: GET /v3/{project_id}/group_snapshots/{group_snapshot_id}
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Shows details for a group snapshot.
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
Response codes
Fix api-ref response code title levels Using the wrong character resulted in the wrong title level being used for the response codes, which in turn caused the "detail" show/hide toggle to not be able to hide all of the per-endpoint details. This corrects these to be at the correct level. Also ran into issues after changing them where sphinx was not happy with the random title levels. This appears to be due to the order processed and whether not earlier included files had all subsequent levels. Adding an additional title in our first included file resolved that problem. Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03 Closes-bug: #1755566
2018-03-13 15:57:54 -05:00
--------------
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
.. rest_status_code:: success ../status.yaml
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
- 200
.. rest_status_code:: error ../status.yaml
- 400
- 404
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Request
-------
.. rest_parameters:: parameters.yaml
[api-ref]Change tenant to project Keystone API v2 was deprecated in Mitaka and uses "project" instead of "tenant" in V3 now. This patch change the "tenant" to "project" in Cinder API v3 doc. Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
2017-01-09 11:51:06 +08:00
- project_id: project_id_path
Improve/Clean api-ref parameters The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-10-30 11:03:09 +05:30
- group_snapshot_id: group_snapshot_id_path
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
- group_snapshot: group_snapshot
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
- created_at: created_at
Improve/Clean api-ref parameters The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-10-30 11:03:09 +05:30
- group_id: source_group_id_req
- id: group_snapshot_id_req
- name: name_group_snap_req
- status: status_group_snap
- description: description_group_snap_req
- group_type_id: group_type_id
Add project_id in group snapshots list and show API Add ``project_id`` to response body of list group snapshots with detail and show group snapshot detail APIs. Merging the group and group snapshot response in same MV was discussed in weekly meeting[1]. [1] http://eavesdrop.openstack.org/meetings/cinder/2019/cinder.2019-02-20-16.00.log.html#l-122 Change-Id: Ided66450b5d7de32551edbce249e94f6174da2eb Implements: blueprint add-project-id-to-group-groupsnapshot-response
2019-02-26 16:55:52 +05:30
- project_id: project_id_group_snapshot
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Response Example
----------------
.. literalinclude:: ./samples/group-snapshots-show-response.json
:language: javascript
List group snapshots with details
Fix Block Storage API reference nesting Modifies heading levels in .inc files to allow nested display in table of contents. Table of contents depth has been changed to allow this. Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
2017-02-02 15:56:50 -06:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
[api-ref]Change tenant to project Keystone API v2 was deprecated in Mitaka and uses "project" instead of "tenant" in V3 now. This patch change the "tenant" to "project" in Cinder API v3 doc. Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
2017-01-09 11:51:06 +08:00
.. rest_method:: GET /v3/{project_id}/group_snapshots/detail
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
Lists all group snapshots with details. Since v3.31 if non-admin
Add documentation for invalid filter keys Now cinder will raise 400 if invalid filter keys are specified, Update the corresponding list APIs. DocImpact Depends-On: ff3d41b15abb2915de87830980147be51e5da971 Change-Id: I8419b374d7f743e7e9fc88e31c8c4f7d9470059b
2017-05-15 11:25:38 +08:00
users specify invalid filters in the url, API will return bad request.
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
Response codes
Fix api-ref response code title levels Using the wrong character resulted in the wrong title level being used for the response codes, which in turn caused the "detail" show/hide toggle to not be able to hide all of the per-endpoint details. This corrects these to be at the correct level. Also ran into issues after changing them where sphinx was not happy with the random title levels. This appears to be due to the order processed and whether not earlier included files had all subsequent levels. Adding an additional title in our first included file resolved that problem. Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03 Closes-bug: #1755566
2018-03-13 15:57:54 -05:00
--------------
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
.. rest_status_code:: success ../status.yaml
- 200
.. rest_status_code:: error ../status.yaml
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
- 400
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Request
-------
.. rest_parameters:: parameters.yaml
[api-ref]Change tenant to project Keystone API v2 was deprecated in Mitaka and uses "project" instead of "tenant" in V3 now. This patch change the "tenant" to "project" in Cinder API v3 doc. Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
2017-01-09 11:51:06 +08:00
- project_id: project_id_path
Api-ref: add 'all_tenants' API query option Cinder REST API allows one to use a special query parameter named "all_tenants" to list resources from all projects (tenants) through the REST API: `/v3/{project_id}/volumes/detail?all_tenants=1` However, this option is hardly documented anywhere besides `/v3/{project_id}/volumes/summary`. So add them. Change-Id: Ia9cc9e20c3b333a054c90f07e952b61dfad8529e Closes-Bug: #1743800
2018-01-18 15:06:15 +08:00
- all_tenants: all-tenants
Use 'min_version' to mark newly added parameters in DOC This patch adds or updates the parameters by using 'min_version' for these two patches below: 1. Added sorter, filter and pagination for group snapshot in v3.29 2. Added metadata in volume/summary response in v3.36 Change-Id: I09f6565d45ea2f346a09c8cb45ff24bec6f14acc
2017-06-29 16:54:05 +08:00
- sort_key: sort_key_group_snapshot
- sort_dir: sort_dir_group_snapshot
- limit: limit_group_snapshot
- offset: offset_group_snapshot
- marker: marker_group_snapshot
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
- group_snapshots: group_snapshots
Improve/Clean api-ref parameters The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-10-30 11:03:09 +05:30
- id: group_snapshot_id_req
- name: name_group_snap_req
- status: status_group_snap
- description: description_group_snap_req
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
- created_at: created_at
Improve/Clean api-ref parameters The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-10-30 11:03:09 +05:30
- group_id: group_id
- group_type_id: group_type_id
Add project_id in group snapshots list and show API Add ``project_id`` to response body of list group snapshots with detail and show group snapshot detail APIs. Merging the group and group snapshot response in same MV was discussed in weekly meeting[1]. [1] http://eavesdrop.openstack.org/meetings/cinder/2019/cinder.2019-02-20-16.00.log.html#l-122 Change-Id: Ided66450b5d7de32551edbce249e94f6174da2eb Implements: blueprint add-project-id-to-group-groupsnapshot-response
2019-02-26 16:55:52 +05:30
- project_id: project_id_group_snapshot
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Response Example
----------------
.. literalinclude:: ./samples/group-snapshots-list-detailed-response.json
:language: javascript
List group snapshots
Fix Block Storage API reference nesting Modifies heading levels in .inc files to allow nested display in table of contents. Table of contents depth has been changed to allow this. Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
2017-02-02 15:56:50 -06:00
~~~~~~~~~~~~~~~~~~~~
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
[api-ref]Change tenant to project Keystone API v2 was deprecated in Mitaka and uses "project" instead of "tenant" in V3 now. This patch change the "tenant" to "project" in Cinder API v3 doc. Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
2017-01-09 11:51:06 +08:00
.. rest_method:: GET /v3/{project_id}/group_snapshots
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Add documentation for invalid filter keys Now cinder will raise 400 if invalid filter keys are specified, Update the corresponding list APIs. DocImpact Depends-On: ff3d41b15abb2915de87830980147be51e5da971 Change-Id: I8419b374d7f743e7e9fc88e31c8c4f7d9470059b
2017-05-15 11:25:38 +08:00
Lists all group snapshots, since v3.31 if non-admin users
specify invalid filters in the url, API will return bad request.
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
Response codes
Fix api-ref response code title levels Using the wrong character resulted in the wrong title level being used for the response codes, which in turn caused the "detail" show/hide toggle to not be able to hide all of the per-endpoint details. This corrects these to be at the correct level. Also ran into issues after changing them where sphinx was not happy with the random title levels. This appears to be due to the order processed and whether not earlier included files had all subsequent levels. Adding an additional title in our first included file resolved that problem. Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03 Closes-bug: #1755566
2018-03-13 15:57:54 -05:00
--------------
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
.. rest_status_code:: success ../status.yaml
- 200
.. rest_status_code:: error ../status.yaml
- 400
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Request
-------
.. rest_parameters:: parameters.yaml
[api-ref]Change tenant to project Keystone API v2 was deprecated in Mitaka and uses "project" instead of "tenant" in V3 now. This patch change the "tenant" to "project" in Cinder API v3 doc. Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
2017-01-09 11:51:06 +08:00
- project_id: project_id_path
Api-ref: add 'all_tenants' API query option Cinder REST API allows one to use a special query parameter named "all_tenants" to list resources from all projects (tenants) through the REST API: `/v3/{project_id}/volumes/detail?all_tenants=1` However, this option is hardly documented anywhere besides `/v3/{project_id}/volumes/summary`. So add them. Change-Id: Ia9cc9e20c3b333a054c90f07e952b61dfad8529e Closes-Bug: #1743800
2018-01-18 15:06:15 +08:00
- all_tenants: all-tenants
Use 'min_version' to mark newly added parameters in DOC This patch adds or updates the parameters by using 'min_version' for these two patches below: 1. Added sorter, filter and pagination for group snapshot in v3.29 2. Added metadata in volume/summary response in v3.36 Change-Id: I09f6565d45ea2f346a09c8cb45ff24bec6f14acc
2017-06-29 16:54:05 +08:00
- sort_key: sort_key_group_snapshot
- sort_dir: sort_dir_group_snapshot
- limit: limit_group_snapshot
- offset: offset_group_snapshot
- marker: marker_group_snapshot
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
- group_snapshots: group_snapshots
Improve/Clean api-ref parameters The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-10-30 11:03:09 +05:30
- id: group_snapshot_id_req
- name: name_group_snap_req
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Response Example
----------------
.. literalinclude:: ./samples/group-snapshots-list-response.json
:language: javascript
Create group snapshot
Fix Block Storage API reference nesting Modifies heading levels in .inc files to allow nested display in table of contents. Table of contents depth has been changed to allow this. Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
2017-02-02 15:56:50 -06:00
~~~~~~~~~~~~~~~~~~~~~
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
[api-ref]Change tenant to project Keystone API v2 was deprecated in Mitaka and uses "project" instead of "tenant" in V3 now. This patch change the "tenant" to "project" in Cinder API v3 doc. Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
2017-01-09 11:51:06 +08:00
.. rest_method:: POST /v3/{project_id}/group_snapshots
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Creates a group snapshot.
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
Response codes
Fix api-ref response code title levels Using the wrong character resulted in the wrong title level being used for the response codes, which in turn caused the "detail" show/hide toggle to not be able to hide all of the per-endpoint details. This corrects these to be at the correct level. Also ran into issues after changing them where sphinx was not happy with the random title levels. This appears to be due to the order processed and whether not earlier included files had all subsequent levels. Adding an additional title in our first included file resolved that problem. Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03 Closes-bug: #1755566
2018-03-13 15:57:54 -05:00
--------------
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
.. rest_status_code:: success ../status.yaml
- 202
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
.. rest_status_code:: error ../status.yaml
- 400
- 404
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Request
-------
.. rest_parameters:: parameters.yaml
[api-ref]Change tenant to project Keystone API v2 was deprecated in Mitaka and uses "project" instead of "tenant" in V3 now. This patch change the "tenant" to "project" in Cinder API v3 doc. Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
2017-01-09 11:51:06 +08:00
- project_id: project_id_path
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
- group_snapshot: group_snapshot
Improve/Clean api-ref parameters The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-10-30 11:03:09 +05:30
- name: name_group_snap
- description: description_group_snap
- group_id: group_id
Add API Reference for groups This patch adds API reference for group types, groups, and group snapshots. Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-07-22 22:17:43 -04:00
Request Example
---------------
.. literalinclude:: ./samples/group-snapshots-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
- group_snapshot: group_snapshot
Improve/Clean api-ref parameters The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-10-30 11:03:09 +05:30
- id: group_snapshot_id_req
- name: name_group_snap_req
- group_type_id: group_type_id
[4/4]Reset generic volume group and group snapshot statuses Currently the administrator could only reset the generic group status by db operation(include snapshots), this change intends to add new admin actions to achieve these. The patch list: 1. group API [1]. 2. snapshot API [2]. 3. cinder client [3]. 4. documentation(this). [1] 92bbacdcef302b09d85618644e1dfc4511841274 [2] 70171dc2ff6b085db90228d98638047bfc6984ba [3] 9820cb6f38b6a68351776c333e5deacd38c5afc9 Partial-Implements: blueprint reset-cg-and-cgs-status Change-Id: I9b985349ccb61e51a91d47d94393b68d901ac738
2016-11-09 16:47:29 +08:00
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
2017-06-20 10:42:09 +08:00
Response Example
----------------
.. literalinclude:: ./samples/group-snapshots-create-response.json
:language: javascript
[4/4]Reset generic volume group and group snapshot statuses Currently the administrator could only reset the generic group status by db operation(include snapshots), this change intends to add new admin actions to achieve these. The patch list: 1. group API [1]. 2. snapshot API [2]. 3. cinder client [3]. 4. documentation(this). [1] 92bbacdcef302b09d85618644e1dfc4511841274 [2] 70171dc2ff6b085db90228d98638047bfc6984ba [3] 9820cb6f38b6a68351776c333e5deacd38c5afc9 Partial-Implements: blueprint reset-cg-and-cgs-status Change-Id: I9b985349ccb61e51a91d47d94393b68d901ac738
2016-11-09 16:47:29 +08:00
Reset group snapshot status
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Doc8: Stop skipping D001: Line too long This cleans up the cases where we had D001 violations so we can stop skipping that check in doc8 runs. Change-Id: Ie52f6ecac1a645fcbcc643b9ca63e033b622d830 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-02-19 16:51:56 -06:00
.. rest_method::
POST /v3/{project_id}/group_snapshots/{group_snapshot_id}/action
[4/4]Reset generic volume group and group snapshot statuses Currently the administrator could only reset the generic group status by db operation(include snapshots), this change intends to add new admin actions to achieve these. The patch list: 1. group API [1]. 2. snapshot API [2]. 3. cinder client [3]. 4. documentation(this). [1] 92bbacdcef302b09d85618644e1dfc4511841274 [2] 70171dc2ff6b085db90228d98638047bfc6984ba [3] 9820cb6f38b6a68351776c333e5deacd38c5afc9 Partial-Implements: blueprint reset-cg-and-cgs-status Change-Id: I9b985349ccb61e51a91d47d94393b68d901ac738
2016-11-09 16:47:29 +08:00
Doc8: Stop skipping D001: Line too long This cleans up the cases where we had D001 violations so we can stop skipping that check in doc8 runs. Change-Id: Ie52f6ecac1a645fcbcc643b9ca63e033b622d830 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-02-19 16:51:56 -06:00
Resets the status for a group snapshot. Specifies the ``reset_status`` action
in the request body.
[4/4]Reset generic volume group and group snapshot statuses Currently the administrator could only reset the generic group status by db operation(include snapshots), this change intends to add new admin actions to achieve these. The patch list: 1. group API [1]. 2. snapshot API [2]. 3. cinder client [3]. 4. documentation(this). [1] 92bbacdcef302b09d85618644e1dfc4511841274 [2] 70171dc2ff6b085db90228d98638047bfc6984ba [3] 9820cb6f38b6a68351776c333e5deacd38c5afc9 Partial-Implements: blueprint reset-cg-and-cgs-status Change-Id: I9b985349ccb61e51a91d47d94393b68d901ac738
2016-11-09 16:47:29 +08:00
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
Response codes
Fix api-ref response code title levels Using the wrong character resulted in the wrong title level being used for the response codes, which in turn caused the "detail" show/hide toggle to not be able to hide all of the per-endpoint details. This corrects these to be at the correct level. Also ran into issues after changing them where sphinx was not happy with the random title levels. This appears to be due to the order processed and whether not earlier included files had all subsequent levels. Adding an additional title in our first included file resolved that problem. Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03 Closes-bug: #1755566
2018-03-13 15:57:54 -05:00
--------------
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
.. rest_status_code:: success ../status.yaml
- 202
.. rest_status_code:: error ../status.yaml
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-01 09:11:44 -06:00
- 400
- 404
[4/4]Reset generic volume group and group snapshot statuses Currently the administrator could only reset the generic group status by db operation(include snapshots), this change intends to add new admin actions to achieve these. The patch list: 1. group API [1]. 2. snapshot API [2]. 3. cinder client [3]. 4. documentation(this). [1] 92bbacdcef302b09d85618644e1dfc4511841274 [2] 70171dc2ff6b085db90228d98638047bfc6984ba [3] 9820cb6f38b6a68351776c333e5deacd38c5afc9 Partial-Implements: blueprint reset-cg-and-cgs-status Change-Id: I9b985349ccb61e51a91d47d94393b68d901ac738
2016-11-09 16:47:29 +08:00
Request
-------
.. rest_parameters:: parameters.yaml
Fix api-ref for reset group snapshot reset-group-snalshot api-ref not correct for 'status' attribute. That is mentioned as optional for request. 'status' in API request is mandatory attribute. Also 'project_id' is mentioned as body element instead of path. Those are confusing while implementing tests for this API - https://review.openstack.org/#/c/495735/ https://developer.openstack.org/api-ref/block-storage/v3/#reset-group-snapshot-status Closes-Bug: #1719930 Change-Id: Id2016f86d0eae60d96df7a12eda1bbec9d1129a8
2017-09-27 15:10:37 +00:00
- project_id: project_id_path
Improve/Clean api-ref parameters The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-10-30 11:03:09 +05:30
- group_snapshot_id: group_snapshot_id_path
api-ref: Make v3 enclosing objects consistent 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
2017-08-29 16:07:03 -05:00
- reset_status: reset_status
Improve/Clean api-ref parameters The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-10-30 11:03:09 +05:30
- status: status_group_snap
[4/4]Reset generic volume group and group snapshot statuses Currently the administrator could only reset the generic group status by db operation(include snapshots), this change intends to add new admin actions to achieve these. The patch list: 1. group API [1]. 2. snapshot API [2]. 3. cinder client [3]. 4. documentation(this). [1] 92bbacdcef302b09d85618644e1dfc4511841274 [2] 70171dc2ff6b085db90228d98638047bfc6984ba [3] 9820cb6f38b6a68351776c333e5deacd38c5afc9 Partial-Implements: blueprint reset-cg-and-cgs-status Change-Id: I9b985349ccb61e51a91d47d94393b68d901ac738
2016-11-09 16:47:29 +08:00
Request Example
---------------
.. literalinclude:: ./samples/group-snapshot-reset-status-request.json
:language: javascript
Copy Permalink