Add API document for share type quota

Add API document for share type quota [1].
[1] https://review.openstack.org/#/c/452158/

Change-Id: I8473428c2eb363cf5a76c672c7fdea72f21e4f63
This commit is contained in:
zhongjun 2017-08-08 16:07:07 +08:00 committed by zhongjun
parent 6f2c8d45eb
commit 976fd7b621
2 changed files with 34 additions and 5 deletions

View File

@ -92,6 +92,15 @@ share_server_id_1:
in: path
required: true
type: string
share_type_for_quota:
description: |
The name or UUID of the share type. If you specify this
parameter in the URI, you show, update, or delete quotas
for this share type.
in: path
required: false
type: string
min_version: 2.39
share_type_id:
description: |
The UUID of the share type.
@ -2302,18 +2311,24 @@ quota_share_groups_request:
type: integer
quota_share_networks:
description: |
The number of share networks allowed for each
tenant.
The number of share networks allowed for user and project,
but not share type.
in: body
required: false
type: integer
quota_share_networks_default:
description: |
The number of share networks allowed for each tenant.
in: body
required: true
type: integer
quota_share_networks_detail:
description: |
The limit, in_use, reserved number of share networks
allowed for each tenant.
allowed for user and project, but not share type.
in: body
min_version: 2.25
required: true
required: false
type: object
quota_share_networks_request:
description: |

View File

@ -11,7 +11,16 @@ Provides quotas management support.
For API versions 2.6 and prior, replace ``quota-sets`` in the URLs with
``os-quota-sets``.
Added share groups and share group snapshots in 2.40 API versions.
Share type quotas were added in API version 2.39. It is possible to set
quotas per share type for the following quota resources:
- ``gigabytes``
- ``snapshots``
- ``shares``
- ``snapshot_gigabytes``
Share groups and share group snapshots were added to quota management
APIs in API version 2.40.
Show default quota set
@ -46,6 +55,7 @@ Response parameters
- share_networks: quota_share_networks
- share_groups: quota_share_groups
- share_group_snapshots: quota_share_group_snapshots
- share_networks: quota_share_networks_default
Response example
----------------
@ -76,6 +86,7 @@ Request
- tenant_id: tenant_id_path
- tenant_id: tenant_id
- user_id: user_id_query
- share_type: share_type_for_quota
Response parameters
-------------------
@ -121,6 +132,7 @@ Request
- tenant_id: tenant_id_path
- tenant_id: tenant_id
- user_id: user_id_query
- share_type: share_type_for_quota
Response parameters
-------------------
@ -175,6 +187,7 @@ Request
- share_networks: quota_share_networks_request
- share_groups: quota_share_groups_request
- share_group_snapshots: quota_share_group_snapshots_request
- share_type: share_type_for_quota
Request example
---------------
@ -226,3 +239,4 @@ Request
- tenant_id: tenant_id_path
- tenant_id: tenant_id
- user_id: user_id_query
- share_type: share_type_for_quota