openstack/cinder
Code Issues Proposed changes
244a75fd6b
cinder/api-ref/source/v3/os-vol-pool-v3.inc

60 lines
1.2 KiB
PHP
Raw Normal View History

Create v3 API Reference The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref was ever created. This is problematic for end users and would hinder the v3 API from being included in DefCore Interoperability Guidelines somewhere down the line (since one of DefCore's Criteria[1] is that a Capability be well documented). This patch creates an API ref for v3. It also adds a header to the v2 index to show that it is SUPPORTED, whereas v3 is CURRENT. [1] http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77 Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e Closes-Bug: #1616072
2016-09-17 01:12:40 -04:00
.. -*- rst -*-
Back-end storage pools
======================
Administrator only. Lists all back-end storage pools that are known
to the scheduler service.
List all back-end storage pools
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create v3 API Reference The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref was ever created. This is problematic for end users and would hinder the v3 API from being included in DefCore Interoperability Guidelines somewhere down the line (since one of DefCore's Criteria[1] is that a Capability be well documented). This patch creates an API ref for v3. It also adds a header to the v2 index to show that it is SUPPORTED, whereas v3 is CURRENT. [1] http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77 Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e Closes-Bug: #1616072
2016-09-17 01:12:40 -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}/scheduler-stats/get_pools
Create v3 API Reference The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref was ever created. This is problematic for end users and would hinder the v3 API from being included in DefCore Interoperability Guidelines somewhere down the line (since one of DefCore's Criteria[1] is that a Capability be well documented). This patch creates an API ref for v3. It also adds a header to the v2 index to show that it is SUPPORTED, whereas v3 is CURRENT. [1] http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77 Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e Closes-Bug: #1616072
2016-09-17 01:12:40 -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 back-end storage pools. Since v3.31 if non-admin users
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
specify invalid filters in the url, API will return bad request.
Create v3 API Reference The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref was ever created. This is problematic for end users and would hinder the v3 API from being included in DefCore Interoperability Guidelines somewhere down the line (since one of DefCore's Criteria[1] is that a Capability be well documented). This patch creates an API ref for v3. It also adds a header to the v2 index to show that it is SUPPORTED, whereas v3 is CURRENT. [1] http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77 Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e Closes-Bug: #1616072
2016-09-17 01:12:40 -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
Create v3 API Reference The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref was ever created. This is problematic for end users and would hinder the v3 API from being included in DefCore Interoperability Guidelines somewhere down the line (since one of DefCore's Criteria[1] is that a Capability be well documented). This patch creates an API ref for v3. It also adds a header to the v2 index to show that it is SUPPORTED, whereas v3 is CURRENT. [1] http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77 Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e Closes-Bug: #1616072
2016-09-17 01:12:40 -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
Create v3 API Reference The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref was ever created. This is problematic for end users and would hinder the v3 API from being included in DefCore Interoperability Guidelines somewhere down the line (since one of DefCore's Criteria[1] is that a Capability be well documented). This patch creates an API ref for v3. It also adds a header to the v2 index to show that it is SUPPORTED, whereas v3 is CURRENT. [1] http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77 Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e Closes-Bug: #1616072
2016-09-17 01:12:40 -04:00
- detail: detail
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
- pools: pools
Create v3 API Reference The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref was ever created. This is problematic for end users and would hinder the v3 API from being included in DefCore Interoperability Guidelines somewhere down the line (since one of DefCore's Criteria[1] is that a Capability be well documented). This patch creates an API ref for v3. It also adds a header to the v2 index to show that it is SUPPORTED, whereas v3 is CURRENT. [1] http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77 Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e Closes-Bug: #1616072
2016-09-17 01:12:40 -04:00
- updated: updated
- QoS_support: QoS_support
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_backend_pool
api-ref: total/free_capacity should be with postfix _gb https://developer.openstack.org/api-ref/block-storage/v3/index.html#list-all-back-end-storage-pools free_capacity and total_capacity in "List all back-end storage pools" should be free_capacity_gb and total_capacity_gb Change-Id: Ic0690d12147fa63b903f3442eccde88c1d501711
2018-09-28 10:32:08 +08:00
- total_capacity_gb: total_capacity
Create v3 API Reference The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref was ever created. This is problematic for end users and would hinder the v3 API from being included in DefCore Interoperability Guidelines somewhere down the line (since one of DefCore's Criteria[1] is that a Capability be well documented). This patch creates an API ref for v3. It also adds a header to the v2 index to show that it is SUPPORTED, whereas v3 is CURRENT. [1] http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77 Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e Closes-Bug: #1616072
2016-09-17 01:12:40 -04:00
- volume_backend_name: volume_backend_name
- capabilities: capabilities
api-ref: total/free_capacity should be with postfix _gb https://developer.openstack.org/api-ref/block-storage/v3/index.html#list-all-back-end-storage-pools free_capacity and total_capacity in "List all back-end storage pools" should be free_capacity_gb and total_capacity_gb Change-Id: Ic0690d12147fa63b903f3442eccde88c1d501711
2018-09-28 10:32:08 +08:00
- free_capacity_gb: free_capacity
Create v3 API Reference The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref was ever created. This is problematic for end users and would hinder the v3 API from being included in DefCore Interoperability Guidelines somewhere down the line (since one of DefCore's Criteria[1] is that a Capability be well documented). This patch creates an API ref for v3. It also adds a header to the v2 index to show that it is SUPPORTED, whereas v3 is CURRENT. [1] http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77 Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e Closes-Bug: #1616072
2016-09-17 01:12:40 -04:00
- driver_version: driver_version
- reserved_percentage: reserved_percentage
- storage_protocol: storage_protocol
Response Example
----------------
.. literalinclude:: ./samples/pools-list-detailed-response.json
:language: javascript
Copy Permalink