From 1323ef7383f44bafbbbb27bf169c678b9b041d0f Mon Sep 17 00:00:00 2001 From: whoami-rajat Date: Wed, 3 Oct 2018 16:59:28 +0530 Subject: [PATCH] API-REF:os-quota-sets v2 API reference has the wrong parameters The request/response parameters for the v2 os-quota-sets API reference is copied from the compute API and is therefore wrong for the block storage API: https://developer.openstack.org/api-ref/block-storage/v2/#quota-sets-extension-os-quota-sets This patch replaces the wrong response with the correct parameters. Change-Id: I6df1d60843943c99505a735a6dec4f47270a1c2e Closes-Bug: #1794125 --- api-ref/source/v2/parameters.yaml | 51 +++++++++++++++ api-ref/source/v2/quota-sets.inc | 103 ++++++++++++------------------ 2 files changed, 92 insertions(+), 62 deletions(-) diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index b0ed7d2c871..ccccf90e1f6 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -324,6 +324,12 @@ backups: in: body required: true type: array +backups_number: + description: | + The number of backups that are allowed for each project. + in: body + required: true + type: integer bootable: description: | Enables or disables the bootable attribute. You @@ -630,6 +636,25 @@ free_capacity: in: body required: true type: string +gigabytes: + description: | + The size (GB) of volumes and snapshots that are allowed for each project. + in: body + required: true + type: integer +gigabytes_for_type: + description: | + The size (GB) of volumes and snapshots that are allowed for each project + and the specified volume type. + in: body + required: true + type: integer +groups_number: + description: | + The number of groups that are allowed for each project. + in: body + required: true + type: integer has_dependent_backups: description: | If this value is ``true``, there are other backups depending on @@ -1521,6 +1546,19 @@ snapshot_id_2: in: body required: false type: string +snapshots_number: + description: | + The number of snapshots that are allowed for each project. + in: body + required: true + type: integer +snapshots_number_for_type: + description: | + The number of snapshots that are allowed for each project and + the specified volume type. + in: body + required: true + type: integer source_cgid: description: | The UUID of the source consistency group. @@ -1854,3 +1892,16 @@ volumes: in: body required: true type: array +volumes_number: + description: | + The number of volumes that are allowed for each project. + in: body + required: true + type: integer +volumes_number_for_type: + description: | + The number of volumes that are allowed for each project and + the specified volume type. + in: body + required: true + type: integer \ No newline at end of file diff --git a/api-ref/source/v2/quota-sets.inc b/api-ref/source/v2/quota-sets.inc index c49417d5369..656e5c6cfb0 100644 --- a/api-ref/source/v2/quota-sets.inc +++ b/api-ref/source/v2/quota-sets.inc @@ -37,23 +37,18 @@ 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: project_id - - security_groups: security_groups - + - volumes: volumes_number + - volumes_{volume_type}: volumes_number_for_type + - snapshots: snapshots_number + - snapshots_{volume_type}: snapshots_number_for_type + - backups: backups_number + - groups: groups_number + - per_volume_gigabytes: per_volume_gigabytes + - gigabytes: gigabytes + - gigabytes_{volume_type}: gigabytes_for_type + - backup_gigabytes: backup_gigabytes Response Example ---------------- @@ -81,25 +76,19 @@ 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 - - security_groups: security_groups - - project_id: quotas_project_id - admin_project_id: admin_project_id - - backup_gigabytes: backup_gigabytes + - project_id: quotas_project_id + - quota_set: quota_set + - volumes: volumes_number + - volumes_{volume_type}: volumes_number_for_type + - snapshots: snapshots_number + - snapshots_{volume_type}: snapshots_number_for_type + - backups: backups_number + - groups: groups_number - per_volume_gigabytes: per_volume_gigabytes + - gigabytes: gigabytes + - gigabytes_{volume_type}: gigabytes_for_type + - backup_gigabytes: backup_gigabytes Request Example --------------- @@ -113,22 +102,17 @@ 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: project_id - - security_groups: security_groups + - volumes: volumes_number + - volumes_{volume_type}: volumes_number_for_type + - snapshots: snapshots_number + - snapshots_{volume_type}: snapshots_number_for_type + - backups: backups_number + - groups: groups_number + - per_volume_gigabytes: per_volume_gigabytes + - gigabytes: gigabytes + - gigabytes_{volume_type}: gigabytes_for_type + - backup_gigabytes: backup_gigabytes Response Example ---------------- @@ -195,23 +179,18 @@ 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: project_id - - security_groups: security_groups - + - volumes: volumes_number + - volumes_{volume_type}: volumes_number_for_type + - snapshots: snapshots_number + - snapshots_{volume_type}: snapshots_number_for_type + - backups: backups_number + - groups: groups_number + - per_volume_gigabytes: per_volume_gigabytes + - gigabytes: gigabytes + - gigabytes_{volume_type}: gigabytes_for_type + - backup_gigabytes: backup_gigabytes Response Example ----------------