a96fad9f3b
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
122 lines
2.6 KiB
ReStructuredText
122 lines
2.6 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Quota class set extension (os-quota-class-sets)
|
|
===============================================
|
|
|
|
Administrators only, depending on policy settings.
|
|
|
|
Shows and updates quota classes for a project.
|
|
|
|
Show quota classes for a project
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{admin_project_id}/os-quota-class-sets/{quota_class_name}
|
|
|
|
Shows quota class set for a project. If no specific value for the quota class
|
|
resource exists, then the default value will be reported.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error ../status.yaml
|
|
|
|
- 403
|
|
- 404
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- quota_class_name: quota_class_name
|
|
- admin_project_id: admin_project_id
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- quota_class_set: quota_class_set
|
|
- backup_gigabytes: maxTotalBackupGigabytes
|
|
- backups: maxTotalBackups
|
|
- gigabytes: maxTotalVolumeGigabytes
|
|
- groups: maxTotalGroups
|
|
- per_volume_gigabytes: per_volume_gigabytes
|
|
- snapshots: maxTotalSnapshots
|
|
- volumes: maxTotalVolumes
|
|
- id: quota_class_id
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/quota-classes-show-response.json
|
|
:language: javascript
|
|
|
|
Update quota classes for a project
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: PUT /v3/{admin_project_id}/os-quota-class-sets/{quota_class_name}
|
|
|
|
Updates quota class set for a project. If the ``quota_class_name`` key does not
|
|
exist, then the API will create one.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error ../status.yaml
|
|
|
|
- 400
|
|
- 403
|
|
- 404
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- admin_project_id: admin_project_id
|
|
- quota_class_name: quota_class_name
|
|
- gigabytes: maxTotalVolumeGigabytesOptional
|
|
- snapshots: maxTotalSnapshotsOptional
|
|
- volumes: maxTotalVolumesOptional
|
|
- volume-type: volume_type_2
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/quota-classes-update-request.json
|
|
:language: javascript
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- quota_class_set: quota_class_set
|
|
- backup_gigabytes: maxTotalBackupGigabytes
|
|
- backups: maxTotalBackups
|
|
- gigabytes: maxTotalVolumeGigabytes
|
|
- groups: maxTotalGroups
|
|
- per_volume_gigabytes: per_volume_gigabytes
|
|
- snapshots: maxTotalSnapshots
|
|
- volumes: maxTotalVolumes
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/quota-classes-update-response.json
|
|
:language: javascript
|