From c3d46e1c97403679cc6a01b67fe2898c719cb1be Mon Sep 17 00:00:00 2001 From: wangxiyuan Date: Wed, 12 Dec 2018 11:44:57 +0800 Subject: [PATCH] [api-ref] add domain level limit support Update api-ref to support domain level limit feature. Change-Id: I7f17a07752432d3e2afd279404362acf04c57a80 bp: domain-level-limit --- api-ref/source/v3/parameters.yaml | 18 ++++++++++++++++++ .../v3/samples/admin/limit-show-response.json | 1 + .../samples/admin/limits-create-request.json | 2 +- .../samples/admin/limits-create-response.json | 4 +++- .../v3/samples/admin/limits-list-response.json | 2 ++ .../samples/admin/limits-update-response.json | 1 + api-ref/source/v3/unified_limits.inc | 8 +++++++- 7 files changed, 33 insertions(+), 3 deletions(-) diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index e34b425cb0..702399f6ed 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -1633,6 +1633,18 @@ request_default_limit_body_not_required: in: body required: false type: integer +request_limit_domain_id_not_required: + description: | + The name of the domain. + in: body + required: false + type: string +request_limit_project_id_not_required: + description: | + The ID for the project. + in: body + required: false + type: string request_region_id_registered_limit_body_not_required: description: | The ID of the region that contains the service endpoint. @@ -1757,6 +1769,12 @@ response_body_system_required: in: body required: true type: array +response_limit_domain_id_body: + description: | + The ID of the domain. + in: body + required: true + type: string role: description: | A ``role`` object diff --git a/api-ref/source/v3/samples/admin/limit-show-response.json b/api-ref/source/v3/samples/admin/limit-show-response.json index 3c50233d5f..66312521b5 100644 --- a/api-ref/source/v3/samples/admin/limit-show-response.json +++ b/api-ref/source/v3/samples/admin/limit-show-response.json @@ -7,6 +7,7 @@ }, "service_id": "9408080f1970482aa0e38bc2d4ea34b7", "project_id": "3a705b9f56bb439381b43c4fe59dccce", + "domain_id": null, "id": "25a04c7a065c430590881c646cdcdd58", "resource_limit": 11, "description": null diff --git a/api-ref/source/v3/samples/admin/limits-create-request.json b/api-ref/source/v3/samples/admin/limits-create-request.json index 2ebf2ffbd8..72a3a00d44 100644 --- a/api-ref/source/v3/samples/admin/limits-create-request.json +++ b/api-ref/source/v3/samples/admin/limits-create-request.json @@ -9,7 +9,7 @@ }, { "service_id": "9408080f1970482aa0e38bc2d4ea34b7", - "project_id": "3a705b9f56bb439381b43c4fe59dccce", + "domain_id": "edbafc92be354ffa977c58aa79c7bdb2", "resource_name": "volume", "resource_limit": 10, "description": "Number of volumes for project 3a705b9f56bb439381b43c4fe59dccce" diff --git a/api-ref/source/v3/samples/admin/limits-create-response.json b/api-ref/source/v3/samples/admin/limits-create-response.json index 9ff5c695ee..a56609fd9d 100644 --- a/api-ref/source/v3/samples/admin/limits-create-response.json +++ b/api-ref/source/v3/samples/admin/limits-create-response.json @@ -7,7 +7,8 @@ "self": "http://10.3.150.25/identity/v3/limits/25a04c7a065c430590881c646cdcdd58" }, "service_id": "9408080f1970482aa0e38bc2d4ea34b7", - "project_id": "3a705b9f56bb439381b43c4fe59dccce", + "project_id": null, + "domain_id": "edbafc92be354ffa977c58aa79c7bdb2", "id": "25a04c7a065c430590881c646cdcdd58", "resource_limit": 10, "description": "Number of volumes for project 3a705b9f56bb439381b43c4fe59dccce" @@ -20,6 +21,7 @@ }, "service_id": "9408080f1970482aa0e38bc2d4ea34b7", "project_id": "3a705b9f56bb439381b43c4fe59dccce", + "domain_id": null, "id": "3229b3849f584faea483d6851f7aab05", "resource_limit": 5, "description": null diff --git a/api-ref/source/v3/samples/admin/limits-list-response.json b/api-ref/source/v3/samples/admin/limits-list-response.json index 002de98756..bcb4828054 100644 --- a/api-ref/source/v3/samples/admin/limits-list-response.json +++ b/api-ref/source/v3/samples/admin/limits-list-response.json @@ -13,6 +13,7 @@ }, "service_id": "9408080f1970482aa0e38bc2d4ea34b7", "project_id": "3a705b9f56bb439381b43c4fe59dccce", + "domain_id": null, "id": "25a04c7a065c430590881c646cdcdd58", "resource_limit": 11, "description": "Number of volumes for project 3a705b9f56bb439381b43c4fe59dccce" @@ -25,6 +26,7 @@ }, "service_id": "9408080f1970482aa0e38bc2d4ea34b7", "project_id": "3a705b9f56bb439381b43c4fe59dccce", + "domain_id": null, "id": "3229b3849f584faea483d6851f7aab05", "resource_limit": 5, "description": null diff --git a/api-ref/source/v3/samples/admin/limits-update-response.json b/api-ref/source/v3/samples/admin/limits-update-response.json index 16171fbf9c..27a7ecee73 100644 --- a/api-ref/source/v3/samples/admin/limits-update-response.json +++ b/api-ref/source/v3/samples/admin/limits-update-response.json @@ -7,6 +7,7 @@ }, "service_id": "9408080f1970482aa0e38bc2d4ea34b7", "project_id": "3a705b9f56bb439381b43c4fe59dccce", + "domain_id": null, "id": "3229b3849f584faea483d6851f7aab05", "resource_limit": 5, "description": "Number of snapshots for project 3a705b9f56bb439381b43c4fe59dccce" diff --git a/api-ref/source/v3/unified_limits.inc b/api-ref/source/v3/unified_limits.inc index b3abf3890a..a5a41c27b6 100644 --- a/api-ref/source/v3/unified_limits.inc +++ b/api-ref/source/v3/unified_limits.inc @@ -367,6 +367,7 @@ Parameters - region_id: region_id_query - resource_name: resource_name_query - project_id: scope_project_id_query + - domain_id: scope_domain_id_query Response @@ -381,6 +382,7 @@ Parameters - limits: limits - id: limit_id - project_id: project_id + - domain_id: response_limit_domain_id_body - service_id: service_id_limit - region_id: region_id_response_body - resource_name: resource_name @@ -426,7 +428,8 @@ Parameters .. rest_parameters:: parameters.yaml - limits: limits - - project_id: project_id + - project_id: request_limit_project_id_not_required + - domain_id: request_limit_domain_id_not_required - service_id: service_id_limit - region_id: region_id_request_body - resource_name: resource_name @@ -452,6 +455,7 @@ Parameters - limits: limits - id: limit_id - project_id: project_id + - domain_id: response_limit_domain_id_body - service_id: service_id_limit - region_id: region_id_response_body - resource_name: resource_name @@ -521,6 +525,7 @@ Parameters - limit: limit - id: limit_id - project_id: project_id + - domain_id: response_limit_domain_id_body - service_id: service_id_limit - region_id: region_id_response_body - resource_name: resource_name @@ -581,6 +586,7 @@ Parameters - limit: limit - id: limit_id - project_id: project_id + - domain_id: response_limit_domain_id_body - service_id: service_id_limit - region_id: region_id_response_body - resource_name: resource_name