From c8138575a25ae2bb11aa7531008462c802a8b04e Mon Sep 17 00:00:00 2001
From: Boden R <bodenvmw@gmail.com>
Date: Fri, 8 Sep 2017 14:17:18 -0600
Subject: [PATCH] api ref for quota details extension

This patch adds API ref for the quota details extension.

Change-Id: Ided70f4718c4422ddee506ca3cc961ac63fd483e
Partial-Bug: #1704914
---
 api-ref/source/v2/index.rst                   |  1 +
 api-ref/source/v2/parameters.yaml             |  9 ++++
 api-ref/source/v2/quota_details.inc           | 41 +++++++++++++++++++
 ...ota-details-show-for-project-response.json | 39 ++++++++++++++++++
 4 files changed, 90 insertions(+)
 create mode 100644 api-ref/source/v2/quota_details.inc
 create mode 100644 api-ref/source/v2/samples/quota_details/quota-details-show-for-project-response.json

diff --git a/api-ref/source/v2/index.rst b/api-ref/source/v2/index.rst
index d375d6ae2..2fa3e95fc 100644
--- a/api-ref/source/v2/index.rst
+++ b/api-ref/source/v2/index.rst
@@ -44,6 +44,7 @@ Resource Management
 .. include:: metering.inc
 .. include:: network-ip-availability.inc
 .. include:: quotas.inc
+.. include:: quota_details.inc
 .. include:: service-providers.inc
 .. include:: tags.inc
 ##################
diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml
index 0ac55dec6..6e062d382 100644
--- a/api-ref/source/v2/parameters.yaml
+++ b/api-ref/source/v2/parameters.yaml
@@ -4496,6 +4496,15 @@ quota:
   in: body
   required: true
   type: object
+quota-detail:
+  description: |
+    A ``quota`` detail object. Each key in the object corresponds to a resource
+    type (``network``, ``port``, etc.) having a quota. The value for each
+    resource type is itself an object (the quota set) containing the quota's
+    ``used``, ``limit`` and ``reserved`` integer values.
+  in: body
+  required: true
+  type: object
 quota-floatingip:
   description: |
     The number of floating IP addresses allowed for
diff --git a/api-ref/source/v2/quota_details.inc b/api-ref/source/v2/quota_details.inc
new file mode 100644
index 000000000..d8def6124
--- /dev/null
+++ b/api-ref/source/v2/quota_details.inc
@@ -0,0 +1,41 @@
+.. -*- 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
diff --git a/api-ref/source/v2/samples/quota_details/quota-details-show-for-project-response.json b/api-ref/source/v2/samples/quota_details/quota-details-show-for-project-response.json
new file mode 100644
index 000000000..82194105a
--- /dev/null
+++ b/api-ref/source/v2/samples/quota_details/quota-details-show-for-project-response.json
@@ -0,0 +1,39 @@
+{
+    "quota": {
+        "rbac_policy": {
+            "used": 4,
+            "limit": 10,
+            "reserved": 0
+        },
+        "subnetpool": {
+            "used": 2,
+            "limit": -1,
+            "reserved": 0
+        },
+        "security_group_rule": {
+            "used": 10,
+            "limit": 100,
+            "reserved": 1
+        },
+        "security_group": {
+            "used": 3,
+            "limit": 10,
+            "reserved": 0
+        },
+        "subnet": {
+            "used": 3,
+            "limit": 100,
+            "reserved": 0
+        },
+        "port": {
+            "used": 21,
+            "limit": 500,
+            "reserved": 3
+        },
+        "network" :{
+            "used": 9,
+            "limit": 100,
+            "reserved": 2
+        }
+    }
+}