Api-ref: Refresh the Update APIs for limits

Refresh the api-ref about limits' Update APIs Change-Id: Id6026b57c23b5acbd71c5d5be1af3bfa0046aa0e
2018-05-21 16:06:39 +08:00 · 2018-05-21 16:06:39 +08:00 · 805d1c7a30
parent c0b0b25e42
commit 805d1c7a30
6 changed files with 52 additions and 91 deletions
--- a/api-ref/source/v3/parameters.yaml
+++ b/api-ref/source/v3/parameters.yaml
@ -1106,6 +1106,12 @@ issued_at:
  in: body
  required: true
  type: string
+limit:
+  description: |
+    A ``limit`` object, containing the following:
+  in: body
+  required: true
+  type: array
 limit_id:
  description: |
    The limit ID.
--- a/api-ref/source/v3/samples/admin/limits-update-request.json
+++ b/api-ref/source/v3/samples/admin/limits-update-request.json
@ -1,13 +1,6 @@
 {
-    "limits":[
-        {
-            "id": "25a04c7a065c430590881c646cdcdd58",
-            "resource_limit": 11
-        },
-        {
-            "id": "3229b3849f584faea483d6851f7aab05",
-            "resource_limit": 5,
-            "description": "Number of snapshots for project 3a705b9f56bb439381b43c4fe59dccce"
-        }
-    ]
+    "limit": {
+        "resource_limit": 5,
+        "description": "Number of snapshots for project 3a705b9f56bb439381b43c4fe59dccce"
+    }
 }
--- a/api-ref/source/v3/samples/admin/limits-update-response.json
+++ b/api-ref/source/v3/samples/admin/limits-update-response.json
@ -1,28 +1,14 @@
 {
-    "limits": [
-        {
-            "resource_name": "volume",
-            "region_id": null,
-            "links": {
-                "self": "http://10.3.150.25/identity/v3/limits/25a04c7a065c430590881c646cdcdd58"
-            },
-            "service_id": "9408080f1970482aa0e38bc2d4ea34b7",
-            "project_id": "3a705b9f56bb439381b43c4fe59dccce",
-            "id": "25a04c7a065c430590881c646cdcdd58",
-            "resource_limit": 11,
-            "description": ""
+    "limit": {
+        "resource_name": "snapshot",
+        "region_id": "RegionOne",
+        "links": {
+            "self": "http://10.3.150.25/identity/v3/limits/3229b3849f584faea483d6851f7aab05"
        },
-        {
-            "resource_name": "snapshot",
-            "region_id": "RegionOne",
-            "links": {
-                "self": "http://10.3.150.25/identity/v3/limits/3229b3849f584faea483d6851f7aab05"
-            },
-            "service_id": "9408080f1970482aa0e38bc2d4ea34b7",
-            "project_id": "3a705b9f56bb439381b43c4fe59dccce",
-            "id": "3229b3849f584faea483d6851f7aab05",
-            "resource_limit": 5,
-            "description": "Number of snapshots for project 3a705b9f56bb439381b43c4fe59dccce"
-        }
-    ]
+        "service_id": "9408080f1970482aa0e38bc2d4ea34b7",
+        "project_id": "3a705b9f56bb439381b43c4fe59dccce",
+        "id": "3229b3849f584faea483d6851f7aab05",
+        "resource_limit": 5,
+        "description": "Number of snapshots for project 3a705b9f56bb439381b43c4fe59dccce"
+    }
 }
--- a/api-ref/source/v3/samples/admin/registered-limits-update-request.json
+++ b/api-ref/source/v3/samples/admin/registered-limits-update-request.json
@ -1,19 +1,9 @@
 {
-    "registered_limits":[
-        {
-            "service_id": "9408080f1970482aa0e38bc2d4ea34b7",
-            "id": "e35a965b2b244209bb0c2b193c55955f",
-            "region_id": "RegionOne",
-            "resource_name": "snapshot",
-            "default_limit": 5,
-            "description": "Number of snapshots"
-        },
-        {
-            "service_id": "9408080f1970482aa0e38bc2d4ea34b7",
-            "id": "773147dd53cd4a17b921d555cf17c633",
-            "resource_name": "volume",
-            "default_limit": 10,
-            "description": ""
-        }
-    ]
+    "registered_limit": {
+        "service_id": "9408080f1970482aa0e38bc2d4ea34b7",
+        "region_id": "RegionOne",
+        "resource_name": "snapshot",
+        "default_limit": 5,
+        "description": "Number of snapshots"
+    }
 }
--- a/api-ref/source/v3/samples/admin/registered-limits-update-response.json
+++ b/api-ref/source/v3/samples/admin/registered-limits-update-response.json
@ -1,26 +1,13 @@
 {
-    "registered_limits": [
-        {
-            "resource_name": "volume",
-            "region_id": null,
-            "links": {
-                "self": "http://10.3.150.25/identity/v3/registered_limits/773147dd53cd4a17b921d555cf17c633"
-            },
-            "service_id": "9408080f1970482aa0e38bc2d4ea34b7",
-            "default_limit": 10,
-            "id": "773147dd53cd4a17b921d555cf17c633",
-            "description": ""
+    "registered_limit": {
+        "resource_name": "snapshot",
+        "region_id": "RegionOne",
+        "links": {
+            "self": "http://10.3.150.25/identity/v3/registered_limits/e35a965b2b244209bb0c2b193c55955f"
        },
-        {
-            "resource_name": "snapshot",
-            "region_id": "RegionOne",
-            "links": {
-                "self": "http://10.3.150.25/identity/v3/registered_limits/e35a965b2b244209bb0c2b193c55955f"
-            },
-            "service_id": "9408080f1970482aa0e38bc2d4ea34b7",
-            "default_limit": 5,
-            "id": "e35a965b2b244209bb0c2b193c55955f",
-            "description": "Number of snapshots"
-        }
-    ]
+        "service_id": "9408080f1970482aa0e38bc2d4ea34b7",
+        "default_limit": 5,
+        "id": "e35a965b2b244209bb0c2b193c55955f",
+        "description": "Number of snapshots"
+    }
 }
--- a/api-ref/source/v3/unified_limits.inc
+++ b/api-ref/source/v3/unified_limits.inc
@ -146,12 +146,11 @@ Examples
 Update Registered Limits
 ========================

-.. rest_method::  PUT /v3/registered_limits
+.. rest_method::  PATCH /v3/registered_limits/{registered_limit_id}

-Updates registered limits. It supports to update more than one registered limit
-in one request.
+Updates the specified registered limit.

-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limits``
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limit``

 Request
 -------
@ -161,8 +160,8 @@ Parameters

 .. rest_parameters:: parameters.yaml

-   - registered_limits: registered_limits
-   - id: registered_limit_id
+   - registered_limit_id: registered_limit_id_path
+   - registered_limit: registered_limit
   - service_id: service_id_registered_limit
   - region_id: region_id_request_body
   - resource_name: resource_name
@ -183,7 +182,7 @@ Parameters

 .. rest_parameters:: parameters.yaml

-   - registered_limits: registered_limits
+   - registered_limit: registered_limit
   - id: registered_limit_id
   - service_id: service_id_registered_limit
   - region_id: region_id_response_body
@ -442,13 +441,12 @@ Examples
 Update Limits
 =============

-.. rest_method::  PUT /v3/limits
+.. rest_method::  PATCH /v3/limits/{limit_id}

-Updates limits. It supports to update more than one limit in one request. It
-only supports to update ``resource_limit`` for limits. It will return all the
-limits for the project.
+Updates the specifeid limit. It only supports to update ``resource_limit`` or
+``description`` for the limit.

-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limits``
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limit``

 Request
 -------
@ -458,7 +456,8 @@ Parameters

 .. rest_parameters:: parameters.yaml

-   - limits: limits
+   - limit_id: limit_id_path
+   - limit: limit
   - resource_limit: resource_limit
   - description: description_limit_request_body

@ -476,7 +475,7 @@ Parameters

 .. rest_parameters:: parameters.yaml

-   - limits: limits
+   - limit: limit
   - id: limit_id
   - service_id: service_id_limit
   - region_id: region_id_response_body
@ -535,7 +534,7 @@ Parameters

 .. rest_parameters:: parameters.yaml

-   - limits: limits
+   - limit: limit
   - id: limit_id
   - project_id: project_id
   - service_id: service_id_limit