From 09deae9d7c3c66d4c850cf11fb298bdf294fffc6 Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Sat, 16 Jan 2016 18:55:57 -0600 Subject: [PATCH] Update os-quota-sets extension - Add request and response parameter descriptions - Update URIs to show both admin_tenant_id and tenant_id Change-Id: Icb0c3657e3f2b46b75604b1a68db9693d023777a Closes-Bug: #1531903 --- api-ref/src/docbkx/ch_compute-v2.1.xml | 43 +-- .../src/wadls/compute-api/src/v2.1/common.ent | 276 +++++++++++------- .../quota-force-update-request.json | 6 - .../quota-force-update-response.json | 18 -- .../os-quota-sets/quota-update-request.json | 3 +- .../os-quota-sets/quota-update-response.json | 22 +- .../quota-user-update-request.json | 6 - .../quota-user-update-response.json | 18 -- ...json => quotas-default-list-response.json} | 24 +- .../quotas-default-show-response.json | 19 -- .../quotas-list-details-response.json | 86 +++++- .../src/v2.1/wadl/os-quota-sets-v2.1.wadl | 153 ++++------ 12 files changed, 353 insertions(+), 321 deletions(-) delete mode 100644 api-ref/src/wadls/compute-api/src/v2.1/samples/os-quota-sets/quota-force-update-request.json delete mode 100644 api-ref/src/wadls/compute-api/src/v2.1/samples/os-quota-sets/quota-force-update-response.json delete mode 100644 api-ref/src/wadls/compute-api/src/v2.1/samples/os-quota-sets/quota-user-update-request.json delete mode 100644 api-ref/src/wadls/compute-api/src/v2.1/samples/os-quota-sets/quota-user-update-response.json rename api-ref/src/wadls/compute-api/src/v2.1/samples/os-quota-sets/{quota-user-show-response.json => quotas-default-list-response.json} (76%) delete mode 100644 api-ref/src/wadls/compute-api/src/v2.1/samples/os-quota-sets/quotas-default-show-response.json diff --git a/api-ref/src/docbkx/ch_compute-v2.1.xml b/api-ref/src/docbkx/ch_compute-v2.1.xml index 1c902cff4..f6820ab39 100644 --- a/api-ref/src/docbkx/ch_compute-v2.1.xml +++ b/api-ref/src/docbkx/ch_compute-v2.1.xml @@ -731,24 +731,31 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
- Quota class (os-quota-class-sets) - - Provides quota classes management support. - - -
-
- Quota sets (os-quota-sets) - - Permits administrators, depending on policy settings, to view quotas - for a project and view and update default quotas. - - -
+ Quota class (os-quota-class-sets) + + Provides quota classes management support. + + + +
+ Quota sets (os-quota-sets) + + Permits administrators, depending on policy settings, to view default + quotas, view details for quotas, revert quotas to defaults, and update the + quotas for a project or a project and user. + + + + + + + + + + + +
Security groups (os-security-groups) diff --git a/api-ref/src/wadls/compute-api/src/v2.1/common.ent b/api-ref/src/wadls/compute-api/src/v2.1/common.ent index be4e8d397..a9c614e57 100644 --- a/api-ref/src/wadls/compute-api/src/v2.1/common.ent +++ b/api-ref/src/wadls/compute-api/src/v2.1/common.ent @@ -83,6 +83,17 @@ '> + + + + The UUID of the administrative tenant. + + +'> @@ -2400,7 +2411,7 @@ '> - @@ -2412,6 +2423,19 @@ + + + + You can force the update even if the quota has already been used and the + reserved quota exceeds the new quota. To force the update, specify the + "force": "True". Default is False. + + + @@ -2578,7 +2602,7 @@ '> - @@ -2593,168 +2617,204 @@ - - - The number of allowed instance cores for each tenant. - - + + + The number of allowed instance cores for each tenant. + + - - - The number of allowed fixed IP addresses for each tenant. Must be equal to - or greater than the number of allowed instances. - - + + + The number of allowed fixed IP addresses for each tenant. Must be equal to + or greater than the number of allowed instances. + + - - - The number of allowed floating IP addresses for each tenant. - - + + + The number of allowed floating IP addresses for each tenant. + + - - - The ID of the quota set. - - + + + The ID of the quota set. + + - - - The number of allowed bytes of content for each injected file. - - + + + The number of allowed bytes of content for each injected file. + + - - - The number of allowed bytes for each injected file path. - - + + + The number of allowed bytes for each injected file path. + + - - - The number of allowed injected files for each tenant. - - + + + The number of allowed injected files for each tenant. + + - - - The number of allowed instances for each tenant. - - + + + The number of allowed instances for each tenant. + + - - - The number of allowed key pairs for each user. - - + + + The number of allowed key pairs for each user. + + - - - The number of allowed metadata items for each instance. - - + + + The number of allowed metadata items for each instance. + + - - - The amount of allowed instance RAM, in MB, for each tenant. - - + + + The amount of allowed instance RAM, in MB, for each tenant. + + - - - The number of allowed rules for each security group. - - + + + The number of allowed rules for each security group. + + - - - The number of allowed security groups for each tenant. - - + + + The number of allowed security groups for each tenant. + + - - - The number of allowed server groups for each tenant. - - + + + The number of allowed server groups for each tenant. + + - - - The number of allowed members for each server group. - - + + + The number of allowed members for each server group. + + +'> + + + + The reserved quota value. + + +'> + + + + The maximum limit for the quota. + + +'> + + + + The in-use quota value. + + '> - + - - &tenant_idTemplateParameter; + + &admin_tenant_idTemplateParameter; - - - - - - - - - &user_idQueryParameter; - - + + &tenant_idTemplateParameter; + + + + + + - - A detailed quotas list. + + + Lists quotas with reserved, limit, and in-use value details. + - - - Deletes a quota for tenant. - - - - - + - Shows default quotas for tenant. + Lists the default quotas for a project or a project and a user. + + + In the request URI, you specify both the ID of the + administrative project and the ID of the project for + which you want to show default quotas. These project IDs can + match. @@ -61,16 +60,19 @@ + "aSetsResponseParameters; - - Lists quotas with details for a tenant. + + Lists quotas with details for a project or a project and a user. + @@ -79,43 +81,34 @@ - &x-openstack-request-idHeader; - - - - - - - Force-updates quota for tenant. - - - - - - - - - - - - - + &x-openstack-request-idHeader; + "aSetsResponseParameters; + &reservedResponseParameter; + &limitResponseParameter; + &in_useResponseParameter; - - Updates quota for tenant. + Update the quotas for a project or a project and a user. + + + You can force the update even if the quota has already been + used and the reserved quota exceeds the new quota. + + + To force the update, specify the "force": "True" + attribute in the request body. Default is False. + The following example request shows the optional + force attribute. + + + To update a quota for a project and a user, specify the user + query parameter. @@ -126,6 +119,8 @@ href="../samples/os-quota-sets/quota-update-request.json" /> + &user_idQueryParameter; + "aSetsRequestParameters; @@ -136,44 +131,24 @@ href="../samples/os-quota-sets/quota-update-response.json" /> + "aSetsResponseParameters; - - + - Deletes quota for a user. + Reverts the quotas to default values for a project or a project and a user. - - - - - - - Updates quota for user. + + To revert quotas for a project and a user, specify the user + query parameter. - - - - - + &user_idQueryParameter; - - - - - - - +