Merge "api-ref: Cleanup quotas API"

api-ref/source/v2/parameters.yaml

@@ -4220,58 +4220,127 @@ quota-floatingip:
   in: body
   required: true
   type: integer
+quota-floatingip-request:
+  description: |
+    The number of floating IP addresses allowed for
+    each project.  A value of ``-1`` means no limit.
+  in: body
+  required: false
+  type: integer
 quota-network:
   description: |
     The number of networks allowed for each project.
+    A value of ``-1`` means no limit.
   in: body
   required: true
   type: integer
+quota-network-request:
+  description: |
+    The number of networks allowed for each project.
+    A value of ``-1`` means no limit.
+  in: body
+  required: false
+  type: integer
 quota-port:
   description: |
     The number of ports allowed for each project.
+    A value of ``-1`` means no limit.
   in: body
   required: true
   type: integer
+quota-port-request:
+  description: |
+    The number of ports allowed for each project.
+    A value of ``-1`` means no limit.
+  in: body
+  required: false
+  type: integer
 quota-rbac_policy:
   description: |
     The number of role-based access control (RBAC)
-    policies for each project.
+    policies for each project. A value of ``-1`` means
+    no limit.
   in: body
   required: true
   type: integer
+quota-rbac_policy-request:
+  description: |
+    The number of role-based access control (RBAC)
+    policies for each project. A value of ``-1`` means
+    no limit.
+  in: body
+  required: false
+  type: integer
 quota-router:
   description: |
     The number of routers allowed for each project.
+    A value of ``-1`` means no limit.
   in: body
   required: true
   type: integer
+quota-router-request:
+  description: |
+    The number of routers allowed for each project.
+    A value of ``-1`` means no limit.
+  in: body
+  required: false
+  type: integer
 quota-security_group:
   description: |
     The number of security groups allowed for each
-    project.
+    project. A value of ``-1`` means no limit.
   in: body
   required: true
   type: integer
+quota-security_group-request:
+  description: |
+    The number of security groups allowed for each
+    project. A value of ``-1`` means no limit.
+  in: body
+  required: false
+  type: integer
 quota-security_group_rule:
   description: |
     The number of security group rules allowed for
-    each project.
+    each project. A value of ``-1`` means no limit.
   in: body
   required: true
   type: integer
+quota-security_group_rule-request:
+  description: |
+    The number of security group rules allowed for
+    each project. A value of ``-1`` means no limit.
+  in: body
+  required: false
+  type: integer
 quota-subnet:
   description: |
     The number of subnets allowed for each project.
+    A value of ``-1`` means no limit.
   in: body
   required: true
   type: integer
+quota-subnet-request:
+  description: |
+    The number of subnets allowed for each project.
+    A value of ``-1`` means no limit.
+  in: body
+  required: false
+  type: integer
 quota-subnetpool:
   description: |
     The number of subnet pools allowed for each
-    project.
+    project. A value of ``-1`` means no limit.
   in: body
   required: true
   type: integer
+quota-subnetpool-request:
+  description: |
+    The number of subnet pools allowed for each
+    project. A value of ``-1`` means no limit.
+  in: body
+  required: false
+  type: integer
 quotas:
   description: |
     A list of quota objects.

api-ref/source/v2/quotas.inc

@@ -1,8 +1,4 @@
 .. -*- rst -*-
-.. needs:method_verification
-.. needs:parameter_verification
-.. needs:example_verification
-.. needs:body_verification
 
 =========================
 Quotas extension (quotas)
@@ -32,16 +28,18 @@ Response Parameters
 
 .. rest_parameters:: parameters.yaml
 
-   - subnet: quota-subnet
-   - network: quota-network
-   - floatingip: quota-floatingip
-   - subnetpool: quota-subnetpool
    - quotas: quotas
-   - security_group_rule: quota-security_group_rule
+   - floatingip: quota-floatingip
-   - security_group: quota-security_group
+   - network: quota-network
-   - router: quota-router
-   - rbac_policy: quota-rbac_policy
    - port: quota-port
+   - project_id: project_id
+   - rbac_policy: quota-rbac_policy
+   - router: quota-router
+   - security_group: quota-security_group
+   - security_group_rule: quota-security_group_rule
+   - subnet: quota-subnet
+   - subnetpool: quota-subnetpool
+   - tenant_id: project_id
 
 Response Example
 ----------------
@@ -72,16 +70,16 @@ Response Parameters
 
 .. rest_parameters:: parameters.yaml
 
-   - subnet: quota-subnet
+   - quota: quota
-   - network: quota-network
    - floatingip: quota-floatingip
-   - subnetpool: quota-subnetpool
+   - network: quota-network
-   - quotas: quotas
-   - security_group_rule: quota-security_group_rule
-   - security_group: quota-security_group
-   - router: quota-router
-   - rbac_policy: quota-rbac_policy
    - port: quota-port
+   - rbac_policy: quota-rbac_policy
+   - router: quota-router
+   - security_group: quota-security_group
+   - security_group_rule: quota-security_group_rule
+   - subnet: quota-subnet
+   - subnetpool: quota-subnetpool
 
 Response Example
 ----------------
@@ -106,16 +104,16 @@ Request
 .. rest_parameters:: parameters.yaml
 
    - project_id: project_id-path
-   - subnet: quota-subnet
+   - quota: quota
-   - network: quota-network
+   - floatingip: quota-floatingip-request
-   - floatingip: quota-floatingip
+   - network: quota-network-request
-   - subnetpool: quota-subnetpool
+   - port: quota-port-request
-   - quotas: quotas
+   - rbac_policy: quota-rbac_policy-request
-   - security_group_rule: quota-security_group_rule
+   - router: quota-router-request
-   - security_group: quota-security_group
+   - security_group: quota-security_group-request
-   - router: quota-router
+   - security_group_rule: quota-security_group_rule-request
-   - rbac_policy: quota-rbac_policy
+   - subnet: quota-subnet-request
-   - port: quota-port
+   - subnetpool: quota-subnetpool-request
 
 Request Example
 ---------------
@@ -128,16 +126,16 @@ Response Parameters
 
 .. rest_parameters:: parameters.yaml
 
-   - subnet: quota-subnet
+   - quota: quota
-   - network: quota-network
    - floatingip: quota-floatingip
-   - subnetpool: quota-subnetpool
+   - network: quota-network
-   - quotas: quotas
-   - security_group_rule: quota-security_group_rule
-   - security_group: quota-security_group
-   - router: quota-router
-   - rbac_policy: quota-rbac_policy
    - port: quota-port
+   - rbac_policy: quota-rbac_policy
+   - router: quota-router
+   - security_group: quota-security_group
+   - security_group_rule: quota-security_group_rule
+   - subnet: quota-subnet
+   - subnetpool: quota-subnetpool
 
 Response Example
 ----------------
@@ -163,6 +161,11 @@ Request
 
    - project_id: project_id-path
 
+Response
+--------
+
+There is no body content for the response of a successful DELETE request.
+
 List default quotas for a project
 =================================
 

api-ref/source/v2/samples/quotas/quotas-list-for-project-response.json

@@ -1,13 +1,13 @@
 {
     "quota": {
-        "subnet": 10,
-        "network": 10,
         "floatingip": 50,
-        "subnetpool": -1,
+        "network": 10,
-        "security_group_rule": 100,
+        "port": 50,
-        "security_group": 10,
-        "router": 10,
         "rbac_policy": -1,
-        "port": 50
+        "router": 10,
+        "security_group": 10,
+        "security_group_rule": 100,
+        "subnet": 10,
+        "subnetpool": -1
     }
 }

api-ref/source/v2/samples/quotas/quotas-list-response.json

@@ -1,17 +1,17 @@
 {
     "quotas": [
         {
-            "subnet": 10,
-            "network": 15,
             "floatingip": 50,
+            "network": 15,
+            "port": 50,
             "project_id": "bab7d5c60cd041a0a36f7c4b6e1dd978",
-            "tenant_id": "bab7d5c60cd041a0a36f7c4b6e1dd978",
-            "subnetpool": -1,
-            "security_group_rule": 100,
-            "security_group": 10,
-            "router": 10,
             "rbac_policy": -1,
-            "port": 50
+            "router": 10,
+            "security_group": 10,
+            "security_group_rule": 100,
+            "subnet": 10,
+            "subnetpool": -1,
+            "tenant_id": "bab7d5c60cd041a0a36f7c4b6e1dd978"
         }
     ]
 }

api-ref/source/v2/samples/quotas/quotas-update-request.json

@@ -1,13 +1,13 @@
 {
     "quota": {
-        "subnet": 10,
-        "network": 10,
         "floatingip": 50,
-        "subnetpool": -1,
+        "network": 10,
-        "security_group_rule": 100,
+        "port": 50,
-        "security_group": 10,
-        "router": 10,
         "rbac_policy": -1,
-        "port": 50
+        "router": 10,
+        "security_group": 10,
+        "security_group_rule": 100,
+        "subnet": 10,
+        "subnetpool": -1
     }
 }