neutron-lib/api-ref/source/v2/quota_details.inc
Boden R c8138575a2 api ref for quota details extension
This patch adds API ref for the quota details extension.

Change-Id: Ided70f4718c4422ddee506ca3cc961ac63fd483e
Partial-Bug: #1704914
2017-09-18 05:11:37 -06:00

42 lines
897 B
ReStructuredText

.. -*- rst -*-
========================================
Quotas details extension (quota_details)
========================================
Extends the ``quotas`` API to show a quota set for each project that includes
the quota's used, limit and reserved counts per resource.
A quota value of ``-1`` means that quota has no limit.
Show quota details for a tenant
===============================
.. rest_method:: GET /v2.0/quotas/{project_id}/details.json
Shows quota details for a project.
Normal response codes: 200
Error response codes: 401, 403
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id-path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- quota: quota-detail
Response Example
----------------
.. literalinclude:: samples/quota_details/quota-details-show-for-project-response.json
:language: javascript