From f16020392d9eb81727a97608f8e9be432f97c388 Mon Sep 17 00:00:00 2001
From: Lingxian Kong <anlin.kong@gmail.com>
Date: Wed, 11 Dec 2019 00:07:11 +1300
Subject: Add quotas resource operation in API doc

Change-Id: I2108f2c6bf067ce228829de9c4e7e47005acf358
---
 api-ref/source/index.rst                        |  1 +
 api-ref/source/parameters.yaml                  | 42 +++++++++++++
 api-ref/source/quotas.inc                       | 80 +++++++++++++++++++++++++
 api-ref/source/samples/quota-show-response.json | 22 +++++++
 api-ref/source/samples/quota-update.json        |  5 ++
 5 files changed, 150 insertions(+)
 create mode 100644 api-ref/source/quotas.inc
 create mode 100644 api-ref/source/samples/quota-show-response.json
 create mode 100644 api-ref/source/samples/quota-update.json

(limited to 'api-ref')

diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst
index 0a754d2c..ae0fc886 100755
--- a/api-ref/source/index.rst
+++ b/api-ref/source/index.rst
@@ -15,3 +15,4 @@
 .. include:: datastores.inc
 .. include:: configurations.inc
 .. include:: backups.inc
+.. include:: quotas.inc
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index a92901fe..293aa9a6 100755
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -60,6 +60,12 @@ user_name:
   in: path
   required: false
   type: string
+user_project:
+  description: |
+    The project ID of the user's project.
+  in: path
+  required: true
+  type: string
 # variables in body
 access:
   description: |
@@ -608,6 +614,42 @@ nics:
   in: body
   required: false
   type: array
+quota_in_use:
+  description: |
+    The used quota for a resource.
+  in: body
+  required: true
+  type: integer
+quota_limit:
+  description: |
+    The limit of a resource quota.
+  in: body
+  required: true
+  type: integer
+quota_list:
+  description: |
+    A list of resource quotas.
+  in: body
+  required: true
+  type: array
+quota_reserved:
+  description: |
+    The reserved quota for a resource.
+  in: body
+  required: true
+  type: integer
+quota_resource:
+  description: |
+    The resource name.
+  in: body
+  required: true
+  type: string
+quotas:
+  description: |
+    Dictionary that defines the resources quota.
+  in: body
+  required: true
+  type: string
 region_name:
   description: |
     The region name of an instance.
diff --git a/api-ref/source/quotas.inc b/api-ref/source/quotas.inc
new file mode 100644
index 00000000..7035bb78
--- /dev/null
+++ b/api-ref/source/quotas.inc
@@ -0,0 +1,80 @@
+.. -*- rst -*-
+
+======
+Quotas
+======
+
+Show and update quotas.
+
+Show resources quota for a specific project
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. rest_method::  GET /v1.0/{project_id}/mgmt/quotas/{user_project}
+
+Admin only action by default.
+
+Normal response codes: 200
+
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - project_id: project_id
+   - user_project: user_project
+
+Response Parameters
+-------------------
+
+.. rest_parameters:: parameters.yaml
+
+    - quotas: quota_list
+    - resource: quota_resource
+    - in_use: quota_in_use
+    - limit: quota_limit
+    - reserved: quota_reserved
+
+Response Example
+----------------
+
+.. literalinclude:: samples/quota-show-response.json
+   :language: javascript
+
+
+Update resources quota for a specific project
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. rest_method::  PUT /v1.0/{project_id}/mgmt/quotas/{user_project}
+
+Admin only action by default.
+
+Normal response codes: 200
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - project_id: project_id
+   - user_project: user_project
+   - quotas: quotas
+
+Request Example
+---------------
+
+.. literalinclude:: samples/quota-update.json
+   :language: javascript
+
+Response Parameters
+-------------------
+
+.. rest_parameters:: parameters.yaml
+
+   - quotas: quotas
+
+Response Example
+----------------
+
+.. literalinclude:: samples/quota-update.json
+   :language: javascript
diff --git a/api-ref/source/samples/quota-show-response.json b/api-ref/source/samples/quota-show-response.json
new file mode 100644
index 00000000..0b0a7f1f
--- /dev/null
+++ b/api-ref/source/samples/quota-show-response.json
@@ -0,0 +1,22 @@
+{
+    "quotas": [
+        {
+            "in_use": 5,
+            "limit": 15,
+            "reserved": 0,
+            "resource": "instances"
+        },
+        {
+            "in_use": 2,
+            "limit": 50,
+            "reserved": 0,
+            "resource": "backups"
+        },
+        {
+            "in_use": 1,
+            "limit": 40,
+            "reserved": 0,
+            "resource": "volumes"
+        }
+    ]
+}
\ No newline at end of file
diff --git a/api-ref/source/samples/quota-update.json b/api-ref/source/samples/quota-update.json
new file mode 100644
index 00000000..e8388632
--- /dev/null
+++ b/api-ref/source/samples/quota-update.json
@@ -0,0 +1,5 @@
+{
+    "quotas": {
+        "instances": 20
+    }
+}
\ No newline at end of file
-- 
cgit v1.2.1