Add count info in /shares and /shares/detail API doc

Added support for display count info
in share list and detail APIs Doc.

Depends-On: I12c41a46140b04f26565d8934e0326480477c612
Partially-Implements bp add-amount-info-in-list-api
Change-Id: I25c41a46190b04f26565d8934e0326480477c613
This commit is contained in:
zhongjun
2017-11-22 11:18:28 +08:00
committed by zhongjun
parent db8b63c139
commit 506aa1cf9c
4 changed files with 20 additions and 0 deletions

View File

@@ -516,6 +516,13 @@ user_id_query:
in: query
required: false
type: string
with_count:
description: |
Whether to show ``count`` in API response or not, default is ``False``.
in: query
required: false
type: boolean
min_version: 2.42
zone_1:
description: |
The availability zone.
@@ -940,6 +947,13 @@ consistent_snapshot_support:
required: true
type: string
min_version: 2.34
count:
description: |
The total count of requested resource before pagination is applied.
in: body
required: false
type: integer
min_version: 2.42
create_share_from_snapshot_support:
description: |
Boolean extra spec used for filtering of back ends by

View File

@@ -78,4 +78,5 @@
"volume_type": "default",
}
]
"count": 10
}

View File

@@ -29,4 +29,5 @@
"name": "Share1"
}
]
"count": 10
}

View File

@@ -119,6 +119,7 @@ Request
- export_location_path: export_location_path_query
- name~: name_inexact_query
- description~: description_inexact_query
- with_count: with_count
Response parameters
-------------------
@@ -128,6 +129,7 @@ Response parameters
- id: id_4
- links: links
- name: name
- count: count
Response example
----------------
@@ -174,6 +176,7 @@ Request
- export_location_path: export_location_path_query
- name~: name_inexact_query
- description~: description_inexact_query
- with_count: with_count
Response parameters
-------------------
@@ -207,6 +210,7 @@ Response parameters
- created_at: created_at_4
- share_proto: share_proto
- volume_type: volume_type
- count: count
Response example
----------------