From cf8eee3f5b6ac8e9800587fd9fcc09efdfba5f7c Mon Sep 17 00:00:00 2001 From: Andrey Volkov Date: Fri, 2 Dec 2016 11:25:05 +0300 Subject: [PATCH] api-ref cleanup: remove quotas user related calls os-quota-sets API call doesn't provide an ability to work with a user. PUT and DELETE methods return "Bad key" error message when user_id is used. GET method just ignores user_id key. In addition, there is not table for storing user related limits as in nova. This change removes the following calls from v1, v2, v3 API descriptions: - Show quotas for user - Update quotas for user - Delete quotas for user - Show quota details for user Partial-Bug: #1415214 DocImpact Change-Id: Ib38f12132f8c4a1f4177e2450e734fffa400dad4 --- api-ref/source/v2/quota-sets.inc | 201 ------------------------------- api-ref/source/v3/quota-sets.inc | 199 ------------------------------ 2 files changed, 400 deletions(-) diff --git a/api-ref/source/v2/quota-sets.inc b/api-ref/source/v2/quota-sets.inc index 24bf1551e91..83368b375a8 100644 --- a/api-ref/source/v2/quota-sets.inc +++ b/api-ref/source/v2/quota-sets.inc @@ -7,156 +7,6 @@ Administrators only, depending on policy settings. Shows, updates, and deletes quotas for a tenant. - -Show quotas for user -~~~~~~~~~~~~~~~~~~~~ - -.. rest_method:: GET /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} - -Enables an admin user to show quotas for a tenant and user. - - -Normal response codes: 200 -Error response codes: - -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - - user_id: user_id - - admin_tenant_id: admin_tenant_id - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - injected_file_content_bytes: injected_file_content_bytes - - metadata_items: metadata_items - - reserved: reserved - - in_use: in_use - - ram: ram - - floating_ips: floating_ips - - key_pairs: key_pairs - - injected_file_path_bytes: injected_file_path_bytes - - instances: instances - - security_group_rules: security_group_rules - - injected_files: injected_files - - quota_set: quota_set - - cores: cores - - fixed_ips: fixed_ips - - id: id - - security_groups: security_groups - -Response Example ----------------- - -.. literalinclude:: ./samples/quotas-update-response.json - :language: javascript - - -Update quotas for user -~~~~~~~~~~~~~~~~~~~~~~ - -.. rest_method:: PUT /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} - -Updates quotas for a tenant and user. - - -Normal response codes: 200 -Error response codes: - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - injected_file_content_bytes: injected_file_content_bytes - - metadata_items: metadata_items - - reserved: reserved - - in_use: in_use - - ram: ram - - floating_ips: floating_ips - - key_pairs: key_pairs - - injected_file_path_bytes: injected_file_path_bytes - - instances: instances - - security_group_rules: security_group_rules - - injected_files: injected_files - - quota_set: quota_set - - cores: cores - - fixed_ips: fixed_ips - - id: id - - security_groups: security_groups - - tenant_id: tenant_id - - user_id: user_id - - admin_tenant_id: admin_tenant_id - -Request Example ---------------- - -.. literalinclude:: ./samples/quotas-update-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - injected_file_content_bytes: injected_file_content_bytes - - metadata_items: metadata_items - - reserved: reserved - - in_use: in_use - - ram: ram - - floating_ips: floating_ips - - key_pairs: key_pairs - - injected_file_path_bytes: injected_file_path_bytes - - instances: instances - - security_group_rules: security_group_rules - - injected_files: injected_files - - quota_set: quota_set - - cores: cores - - fixed_ips: fixed_ips - - id: id - - security_groups: security_groups - -Response Example ----------------- - -.. literalinclude:: ./samples/quotas-update-response.json - :language: javascript - -Delete quotas for user -~~~~~~~~~~~~~~~~~~~~~~ - -.. rest_method:: DELETE /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} - -Deletes quotas for a user so that the quotas revert to default values. - - -Normal response codes: 200 -Error response codes: - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - - user_id: user_id - - admin_tenant_id: admin_tenant_id - -Response Example ----------------- - -.. literalinclude:: ./samples/quotas-delete-response.json - :language: javascript - - Show quotas ~~~~~~~~~~~ @@ -305,57 +155,6 @@ Response Example .. literalinclude:: ./samples/quotas-delete-response.json :language: javascript -Show quota details for user -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. rest_method:: GET /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}/detail/{user_id} - -Shows details for quotas for a tenant and user. - - -Normal response codes: 200 -Error response codes: - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - - user_id: user_id - - admin_tenant_id: admin_tenant_id - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - injected_file_content_bytes: injected_file_content_bytes - - metadata_items: metadata_items - - reserved: reserved - - in_use: in_use - - ram: ram - - floating_ips: floating_ips - - key_pairs: key_pairs - - injected_file_path_bytes: injected_file_path_bytes - - instances: instances - - security_group_rules: security_group_rules - - injected_files: injected_files - - quota_set: quota_set - - cores: cores - - fixed_ips: fixed_ips - - id: id - - security_groups: security_groups - -Response Example ----------------- - -.. literalinclude:: ./samples/quotas-update-response.json - :language: javascript - - Get default quotas ~~~~~~~~~~~~~~~~~~ diff --git a/api-ref/source/v3/quota-sets.inc b/api-ref/source/v3/quota-sets.inc index 1e51ed1446a..28058c6a3af 100644 --- a/api-ref/source/v3/quota-sets.inc +++ b/api-ref/source/v3/quota-sets.inc @@ -8,155 +8,6 @@ Administrators only, depending on policy settings. Shows, updates, and deletes quotas for a project. -Show quotas for a user -~~~~~~~~~~~~~~~~~~~~~~ - -.. rest_method:: GET /v3/{admin_project_id}/os-quota-sets/{project_id}/{user_id} - -Enables an admin user to show quotas for a project and user. - - -Normal response codes: 200 -Error response codes: - -Request -------- - -.. rest_parameters:: parameters.yaml - - - project_id: project_id_path - - user_id: user_id - - admin_project_id: admin_project_id - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - injected_file_content_bytes: injected_file_content_bytes - - metadata_items: metadata_items - - reserved: reserved - - in_use: in_use - - ram: ram - - floating_ips: floating_ips - - key_pairs: key_pairs - - injected_file_path_bytes: injected_file_path_bytes - - instances: instances - - security_group_rules: security_group_rules - - injected_files: injected_files - - quota_set: quota_set - - cores: cores - - fixed_ips: fixed_ips - - id: id - - security_groups: security_groups - -Response Example ----------------- - -.. literalinclude:: ./samples/quotas-update-response.json - :language: javascript - - -Update quotas for a user -~~~~~~~~~~~~~~~~~~~~~~~~ - -.. rest_method:: PUT /v3/{admin_project_id}/os-quota-sets/{project_id}/{user_id} - -Updates quotas for a project and user. - - -Normal response codes: 200 -Error response codes: - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - injected_file_content_bytes: injected_file_content_bytes - - metadata_items: metadata_items - - reserved: reserved - - in_use: in_use - - ram: ram - - floating_ips: floating_ips - - key_pairs: key_pairs - - injected_file_path_bytes: injected_file_path_bytes - - instances: instances - - security_group_rules: security_group_rules - - injected_files: injected_files - - quota_set: quota_set - - cores: cores - - fixed_ips: fixed_ips - - id: id - - security_groups: security_groups - - project_id: project_id_path - - user_id: user_id - - admin_project_id: admin_project_id - -Request Example ---------------- - -.. literalinclude:: ./samples/quotas-update-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - injected_file_content_bytes: injected_file_content_bytes - - metadata_items: metadata_items - - reserved: reserved - - in_use: in_use - - ram: ram - - floating_ips: floating_ips - - key_pairs: key_pairs - - injected_file_path_bytes: injected_file_path_bytes - - instances: instances - - security_group_rules: security_group_rules - - injected_files: injected_files - - quota_set: quota_set - - cores: cores - - fixed_ips: fixed_ips - - id: id - - security_groups: security_groups - -Response Example ----------------- - -.. literalinclude:: ./samples/quotas-update-response.json - :language: javascript - -Delete quotas for a user -~~~~~~~~~~~~~~~~~~~~~~~~ - -.. rest_method:: DELETE /v3/{admin_project_id}/os-quota-sets/{project_id}/{user_id} - -Deletes quotas for a user so that the quotas revert to default values. - - -Normal response codes: 200 -Error response codes: - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - project_id: project_id_path - - user_id: user_id - - admin_project_id: admin_project_id - -Response Example ----------------- - -.. literalinclude:: ./samples/quotas-delete-response.json - :language: javascript - - Show quotas for a project ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -305,56 +156,6 @@ Response Example .. literalinclude:: ./samples/quotas-delete-response.json :language: javascript -Show quota details for a user -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. rest_method:: GET /v3/{admin_project_id}/os-quota-sets/{project_id}/detail/{user_id} - -Shows details for quotas for a project and user. - - -Normal response codes: 200 -Error response codes: - - -Request -------- - -.. rest_parameters:: parameters.yaml - - - project_id: project_id_path - - user_id: user_id - - admin_project_id: admin_project_id - - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - injected_file_content_bytes: injected_file_content_bytes - - metadata_items: metadata_items - - reserved: reserved - - in_use: in_use - - ram: ram - - floating_ips: floating_ips - - key_pairs: key_pairs - - injected_file_path_bytes: injected_file_path_bytes - - instances: instances - - security_group_rules: security_group_rules - - injected_files: injected_files - - quota_set: quota_set - - cores: cores - - fixed_ips: fixed_ips - - id: id - - security_groups: security_groups - -Response Example ----------------- - -.. literalinclude:: ./samples/quotas-update-response.json - :language: javascript - Get default quotas for a project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~