Add API document for share group quotas

"Quota" APIs now will return two new following keys [1]:

- 'share_groups'
- 'share_group_snapshots'

[1] https://review.openstack.org/#/c/473464/

DocImpact
Partially Implements BluePrint add-share-groups-quota
Change-Id: I497a8e886236cb22fa50abdf2a4a938bb04c655d
This commit is contained in:
zhongjun 2017-08-08 15:16:37 +08:00 committed by zhongjun
parent 50e8c5a42d
commit 52ea955a89
5 changed files with 69 additions and 3 deletions

View File

@ -2277,6 +2277,50 @@ quota_set:
in: body
required: true
type: object
quota_share_group_snapshots:
description: |
The number of share group snapshots allowed for each tenant or user.
in: body
min_version: 2.40
required: true
type: integer
quota_share_group_snapshots_detail:
description: |
The limit, in_use, reserved number of share group snapshots
for each tenant or user.
in: body
min_version: 2.40
required: true
type: object
quota_share_group_snapshots_request:
description: |
The number of share group snapshots allowed for each tenant or user.
in: body
min_version: 2.40
required: false
type: integer
quota_share_groups:
description: |
The number of share groups allowed for each tenant or user.
in: body
min_version: 2.40
required: true
type: integer
quota_share_groups_detail:
description: |
The limit, in_use, reserved number of share groups
for each tenant or user.
in: body
min_version: 2.40
required: true
type: object
quota_share_groups_request:
description: |
The number of share groups allowed for each tenant or user.
in: body
min_version: 2.40
required: false
type: integer
quota_share_networks:
description: |
The number of share networks allowed for each

View File

@ -11,6 +11,8 @@ 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.
Show default quota set
======================
@ -42,6 +44,8 @@ Response parameters
- shares: quota_shares
- snapshot_gigabytes: quota_snapshot_gigabytes
- share_networks: quota_share_networks
- share_groups: quota_share_groups
- share_group_snapshots: quota_share_group_snapshots
Response example
----------------
@ -85,6 +89,8 @@ Response parameters
- shares: quota_shares
- snapshot_gigabytes: quota_snapshot_gigabytes
- share_networks: quota_share_networks
- share_groups: quota_share_groups
- share_group_snapshots: quota_share_group_snapshots
Response example
----------------
@ -128,6 +134,8 @@ Response parameters
- shares: quota_shares_detail
- snapshot_gigabytes: quota_snapshot_gigabytes_detail
- share_networks: quota_share_networks_detail
- share_groups: quota_share_groups_detail
- share_group_snapshots: quota_share_group_snapshots_detail
Response example
----------------
@ -165,6 +173,8 @@ Request
- snapshot_gigabytes: quota_snapshot_gigabytes_request
- shares: quota_shares_request
- share_networks: quota_share_networks_request
- share_groups: quota_share_groups_request
- share_group_snapshots: quota_share_group_snapshots_request
Request example
---------------
@ -184,6 +194,8 @@ Response parameters
- shares: quota_shares
- snapshot_gigabytes: quota_snapshot_gigabytes
- share_networks: quota_share_networks
- share_groups: quota_share_groups
- share_group_snapshots: quota_share_group_snapshots
Response example
----------------

View File

@ -15,6 +15,12 @@
"reserved": 0},
"share_networks": {"in_use": 0,
"limit": 10,
"reserved": 0}
"reserved": 0},
"share_groups": {"in_use": 0,
"limit": 10,
"reserved": 0},
"share_group_snapshots": {"in_use": 0,
"limit": 10,
"reserved": 0}
}
}

View File

@ -5,6 +5,8 @@
"snapshot_gigabytes": 1000,
"snapshots": 50,
"id": "16e1ab15c35a457e9c2b2aa189f544e1",
"share_networks": 10
"share_networks": 10,
"share_groups": 10,
"share_group_snapshots": 10
}
}

View File

@ -4,6 +4,8 @@
"snapshot_gigabytes": 999,
"shares": 50,
"snapshots": 49,
"share_networks": 9
"share_networks": 9,
"share_groups": 12,
"share_group_snapshots": 12
}
}