openstack/cinder
Code Issues Proposed changes
32f1145b7d
cinder/api-ref/source/v3/quota-sets.inc

253 lines
5.3 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 -*-
Quota sets extension (os-quota-sets)
====================================
Administrators only, depending on policy settings.
[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
Shows, updates, and deletes quotas for a project.
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
Show quotas for a project
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/{admin_project_id}/os-quota-sets/{project_id}
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
Shows quotas for a project.
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
--------------
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
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
- admin_project_id: admin_project_id
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
- project_id: quotas_project_id
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
- usage: usage
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- quota_set: quota_set
Update the description of quota's project id Instead of QoS id, project id should be used for quota's id attribute. Change-Id: I201350caa984b66baf38ce9d74d09c7eda913034
2018-01-25 11:38:19 +08:00
- id: project_id
[Api-ref] Update quota-set APIs ref The api-ref for quota-set is totally wrong. This patch updated it to keep the same with Cinder's behavior. Change-Id: Ib71d53e920a867ff080c929672f3120a639e3a28 Closes-bug: #1696347
2017-06-14 12:02:12 +08:00
- volumes: volumes_number
- volumes_{volume_type}: volumes_number_for_type
- snapshots: snapshots_number
- snapshots_{volume_type}: snapshots_number_for_type
- backups: backups_number
- groups: groups_number
- per_volume_gigabytes: per_volume_gigabytes
- gigabytes: gigabytes
- gigabytes_{volume_type}: gigabytes_for_type
- backup_gigabytes: backup_gigabytes
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
Response Example
----------------
Automate generation of quotas api-ref samples This patch adds the following tests: 1) quota sets 2) quota classes Change-Id: Ie52071c0b69b49eee340ebf4b06446e824c4b5fe Partially-Implements: blueprint generating-sample-files
2019-09-30 11:44:32 +05:30
.. literalinclude:: ./samples/quota_sets/quotas-show-response.json
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
:language: javascript
Add API document for quota usage. This patch adds a new API document for quota usage as it has different response with quota show. Change-Id: I0a55056f0962743015fec31ce2785aaf482c184d
2017-07-31 17:52:11 +08:00
Show quota usage for a project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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::
GET /v3/{admin_project_id}/os-quota-sets/{project_id}?{usage}=True
Add API document for quota usage. This patch adds a new API document for quota usage as it has different response with quota show. Change-Id: I0a55056f0962743015fec31ce2785aaf482c184d
2017-07-31 17:52:11 +08:00
Shows quota usage for a project.
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
Add API document for quota usage. This patch adds a new API document for quota usage as it has different response with quota show. Change-Id: I0a55056f0962743015fec31ce2785aaf482c184d
2017-07-31 17:52:11 +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
- 200
Add API document for quota usage. This patch adds a new API document for quota usage as it has different response with quota show. Change-Id: I0a55056f0962743015fec31ce2785aaf482c184d
2017-07-31 17:52:11 +08:00
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: quotas_project_id
- admin_project_id: admin_project_id
- usage: usage
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- quota_set: quota_set
Update the description of quota's project id Instead of QoS id, project id should be used for quota's id attribute. Change-Id: I201350caa984b66baf38ce9d74d09c7eda913034
2018-01-25 11:38:19 +08:00
- id: project_id
Add API document for quota usage. This patch adds a new API document for quota usage as it has different response with quota show. Change-Id: I0a55056f0962743015fec31ce2785aaf482c184d
2017-07-31 17:52:11 +08:00
- volumes: volumes_number_usage
- volumes_{volume_type}: volumes_number_for_type_usage
- snapshots: snapshots_number_usage
- snapshots_{volume_type}: snapshots_number_for_type_usage
- backups: backups_number_usage
- groups: groups_number_usage
- per_volume_gigabytes: per_volume_gigabytes_usage
- gigabytes: gigabytes_usage
- gigabytes_{volume_type}: gigabytes_for_type_usage
- backup_gigabytes: backup_gigabytes_usage
Response Example
----------------
Automate generation of quotas api-ref samples This patch adds the following tests: 1) quota sets 2) quota classes Change-Id: Ie52071c0b69b49eee340ebf4b06446e824c4b5fe Partially-Implements: blueprint generating-sample-files
2019-09-30 11:44:32 +05:30
.. literalinclude:: ./samples/quota_sets/quotas-show-usage-response.json
Add API document for quota usage. This patch adds a new API document for quota usage as it has different response with quota show. Change-Id: I0a55056f0962743015fec31ce2785aaf482c184d
2017-07-31 17:52:11 +08:00
:language: javascript
[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
Update quotas for a project
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:: PUT /v3/{admin_project_id}/os-quota-sets/{project_id}
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
Updates quotas for a project.
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
--------------
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
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
- admin_project_id: admin_project_id
[Api-ref] Update quota-set APIs ref The api-ref for quota-set is totally wrong. This patch updated it to keep the same with Cinder's behavior. Change-Id: Ib71d53e920a867ff080c929672f3120a639e3a28 Closes-bug: #1696347
2017-06-14 12:02:12 +08:00
- project_id: quotas_project_id
- quota_set: quota_set
- volumes: volumes_number
- volumes_{volume_type}: volumes_number_for_type
- snapshots: snapshots_number
- snapshots_{volume_type}: snapshots_number_for_type
- backups: backups_number
- groups: groups_number
- per_volume_gigabytes: per_volume_gigabytes
- gigabytes: gigabytes
- gigabytes_{volume_type}: gigabytes_for_type
- backup_gigabytes: backup_gigabytes
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 Example
---------------
Automate generation of quotas api-ref samples This patch adds the following tests: 1) quota sets 2) quota classes Change-Id: Ie52071c0b69b49eee340ebf4b06446e824c4b5fe Partially-Implements: blueprint generating-sample-files
2019-09-30 11:44:32 +05:30
.. literalinclude:: ./samples/quota_sets/quotas-update-request.json
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
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- quota_set: quota_set
[Api-ref] Update quota-set APIs ref The api-ref for quota-set is totally wrong. This patch updated it to keep the same with Cinder's behavior. Change-Id: Ib71d53e920a867ff080c929672f3120a639e3a28 Closes-bug: #1696347
2017-06-14 12:02:12 +08:00
- volumes: volumes_number
- volumes_{volume_type}: volumes_number_for_type
- snapshots: snapshots_number
- snapshots_{volume_type}: snapshots_number_for_type
- backups: backups_number
- groups: groups_number
- per_volume_gigabytes: per_volume_gigabytes
- gigabytes: gigabytes
- gigabytes_{volume_type}: gigabytes_for_type
- backup_gigabytes: backup_gigabytes
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
Response Example
----------------
Automate generation of quotas api-ref samples This patch adds the following tests: 1) quota sets 2) quota classes Change-Id: Ie52071c0b69b49eee340ebf4b06446e824c4b5fe Partially-Implements: blueprint generating-sample-files
2019-09-30 11:44:32 +05:30
.. literalinclude:: ./samples/quota_sets/quotas-update-response.json
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
:language: javascript
[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
Delete quotas for a project
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:: DELETE /v3/{admin_project_id}/os-quota-sets/{project_id}
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
Deletes quotas for a project so the quotas revert to default values.
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
--------------
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
.. rest_status_code:: success ../status.yaml
- 200
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 cleanup: required flag for tenants Current url scheme doesn't allow to skip admin_tenant_id or tenant_id params. This change marks them as required in api-ref. Get default quotas for a project signature was changed on correct also. Partial-Bug: #1415214 Change-Id: I0c528d1c49346477b608a12f8f35ee6d47404bd3
2016-12-02 12:17:08 +03:00
- project_id: quotas_project_id
[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
- admin_project_id: admin_project_id
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
Get default quotas for a project
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
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::
GET /v3/{admin_project_id}/os-quota-sets/{project_id}/defaults
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
Gets default quotas for a project.
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
--------------
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
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
- 200
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
api-ref cleanup: required flag for tenants Current url scheme doesn't allow to skip admin_tenant_id or tenant_id params. This change marks them as required in api-ref. Get default quotas for a project signature was changed on correct also. Partial-Bug: #1415214 Change-Id: I0c528d1c49346477b608a12f8f35ee6d47404bd3
2016-12-02 12:17:08 +03:00
- admin_project_id: admin_project_id
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
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- quota_set: quota_set
Update the description of quota's project id Instead of QoS id, project id should be used for quota's id attribute. Change-Id: I201350caa984b66baf38ce9d74d09c7eda913034
2018-01-25 11:38:19 +08:00
- id: project_id
[Api-ref] Update quota-set APIs ref The api-ref for quota-set is totally wrong. This patch updated it to keep the same with Cinder's behavior. Change-Id: Ib71d53e920a867ff080c929672f3120a639e3a28 Closes-bug: #1696347
2017-06-14 12:02:12 +08:00
- volumes: volumes_number
- volumes_{volume_type}: volumes_number_for_type
- snapshots: snapshots_number
- snapshots_{volume_type}: snapshots_number_for_type
- backups: backups_number
- groups: groups_number
- per_volume_gigabytes: per_volume_gigabytes
- gigabytes: gigabytes
- gigabytes_{volume_type}: gigabytes_for_type
- backup_gigabytes: backup_gigabytes
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
Response Example
----------------
Automate generation of quotas api-ref samples This patch adds the following tests: 1) quota sets 2) quota classes Change-Id: Ie52071c0b69b49eee340ebf4b06446e824c4b5fe Partially-Implements: blueprint generating-sample-files
2019-09-30 11:44:32 +05:30
.. literalinclude:: ./samples/quota_sets/quotas-show-defaults-response.json
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
:language: javascript
Copy Permalink