openstack/cinder
Code Issues Proposed changes
ffc33984d9
cinder/api-ref/source/v3/samples
History
TommyLike 23b7463984 Support count info in List&Detail APIs 
This patch adds support for display count info
in volume, backup and snapshot's list&detail APIs
since microversion 3.45, for instance:

1. /v3/{project_id}/volumes?with_count=True
2. /v3/{project_id}/volumes/detail?with_count=True

Depends-On: 1c8fe0ade4
Change-Id: I2e92b27c36357120fcf0ec5917c6484441c946a8
Implements: bp add-amount-info-in-list-api
2017-10-25 08:43:47 +00:00
..
attachment-complete.json [Api-ref] Add api doc for attachment complete 2017-08-31 00:58:44 +08:00
attachment-create-request.json Add attachment API doc 2017-04-21 10:30:41 +08:00
attachment-create-response.json Add attachment API doc 2017-04-21 10:30:41 +08:00
attachment-list-detailed-response.json Add attachment API doc 2017-04-21 10:30:41 +08:00
attachment-list-response.json Add attachment API doc 2017-04-21 10:30:41 +08:00
attachment-show-response.json Add attachment API doc 2017-04-21 10:30:41 +08:00
attachment-update-request.json Add attachment API doc 2017-04-21 10:30:41 +08:00
attachment-update-response.json Add attachment API doc 2017-04-21 10:30:41 +08:00
backend-capabilities-response.json Add two response parameters in the api-ref of getting capabilities 2017-03-25 12:25:07 +08:00
backup-create-request.json [Api-ref] Add metatdata parameters to backup create/update 2017-08-08 15:12:03 +08:00
backup-create-response.json [Api-ref] Add metatdata parameters to backup create/update 2017-08-08 15:12:03 +08:00
backup-force-delete-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
backup-record-export-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
backup-record-import-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
backup-record-import-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
backup-reset-status-request.json Api-ref: add documentation for v2/v3 backup 'os-reset_status' action 2017-06-26 17:05:43 +08:00
backup-restore-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
backup-restore-response.json Add v2 v3 response example in API doc 2017-06-20 08:24:52 +00:00
backup-show-response.json Merge "[Api-ref]: Add missing key/values in the json files." 2017-09-12 22:38:24 +00:00
backup-update-request.json [Api-ref] Add metatdata parameters to backup create/update 2017-08-08 15:12:03 +08:00
backup-update-response.json [Api-ref] Add metatdata parameters to backup create/update 2017-08-08 15:12:03 +08:00
backups-list-detailed-response.json Support count info in List&Detail APIs 2017-10-25 08:43:47 +00:00
backups-list-response.json Support count info in List&Detail APIs 2017-10-25 08:43:47 +00:00
cgsnapshots-create-request.json api-ref: Make v3 enclosing objects consistent 2017-09-01 09:54:34 -05:00
cgsnapshots-create-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
cgsnapshots-list-detailed-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
cgsnapshots-list-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
cgsnapshots-show-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
consistency-group-create-from-src-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
consistency-group-create-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
consistency-group-create-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
consistency-group-delete-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
consistency-group-show-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
consistency-group-update-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
consistency-groups-list-detailed-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
consistency-groups-list-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
encryption-type-create-request.json Update provider parameter in sample json files 2017-09-27 14:24:13 -04:00
encryption-type-create-response.json Update provider parameter in sample json files 2017-09-27 14:24:13 -04:00
encryption-type-show-response.json Update provider parameter in sample json files 2017-09-27 14:24:13 -04:00
encryption-type-update-request.json Update provider parameter in sample json files 2017-09-27 14:24:13 -04:00
encryption-type-update-response.json Update provider parameter in sample json files 2017-09-27 14:24:13 -04:00
extensions-list-response.json Replace http with https for doc links in cinder 2017-10-17 11:14:01 +08:00
group-create-from-src-request.json api-ref: Make v3 enclosing objects consistent 2017-09-01 09:54:34 -05:00
group-create-request.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-create-response.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-delete-request.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-replication-disable.json api-ref: Add group replication APIs 2017-08-27 09:49:19 -05:00
group-replication-enable.json api-ref: Add group replication APIs 2017-08-27 09:49:19 -05:00
group-replication-failover.json api-ref: Add group replication APIs 2017-08-27 09:49:19 -05:00
group-replication-list-targets.json api-ref: Add group replication APIs 2017-08-27 09:49:19 -05:00
group-replication-target.json api-ref: Add group replication APIs 2017-08-27 09:49:19 -05:00
group-reset-status-request.json [4/4]Reset generic volume group and group snapshot statuses 2017-02-13 19:38:22 +08:00
group-show-response.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-snapshot-reset-status-request.json [4/4]Reset generic volume group and group snapshot statuses 2017-02-13 19:38:22 +08:00
group-snapshots-create-request.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-snapshots-create-response.json Add v2 v3 response example in API doc 2017-06-20 08:24:52 +00:00
group-snapshots-list-detailed-response.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-snapshots-list-response.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-snapshots-show-response.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-type-create-request.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-type-show-request.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-type-show-response.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-type-specs-create-request.json Add missing api-ref documents for group type specs 2017-07-18 01:07:09 +00:00
group-type-specs-create-response.json Add missing api-ref documents for group type specs 2017-07-18 01:07:09 +00:00
group-type-specs-list-response.json Add missing api-ref documents for group type specs 2017-07-18 01:07:09 +00:00
group-type-specs-show-response.json Add missing api-ref documents for group type specs 2017-07-18 01:07:09 +00:00
group-type-specs-update-response.json Add missing api-ref documents for group type specs 2017-07-18 01:07:09 +00:00
group-type-update-request.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-types-list-response.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-update-request.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
groups-list-detailed-response.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
groups-list-response.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
host-attach-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
hosts-get-response.json Adds API documentation for list and show hosts. 2017-03-14 05:36:24 -04:00
hosts-list-response.json Adds API documentation for list and show hosts. 2017-03-14 05:36:24 -04:00
image-metadata-show-request.json Correct 'os-show_image_metadata' API document 2017-08-02 08:55:46 +08:00
image-metadata-show-response.json Correct 'os-show_image_metadata' API document 2017-08-02 08:55:46 +08:00
limits-show-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
messages-list-response.json [Doc] Add documentation for messages API. 2017-03-23 20:22:49 +08:00
messages-show-response.json [Doc] Add documentation for messages API. 2017-03-23 20:22:49 +08:00
pools-list-detailed-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
qos_show_response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
qos-create-request.json api-ref: Make v3 enclosing objects consistent 2017-09-01 09:54:34 -05:00
qos-create-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
qos-list-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
qos-show-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
qos-unset-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
qos-unset-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
qos-update-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
qos-update-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
quota-classes-show-response.json [api-ref] Add api-ref for os-quota-class-sets APIs 2017-08-08 13:02:36 +00:00
quota-classes-update-request.json [api-ref] Add api-ref for os-quota-class-sets APIs 2017-08-08 13:02:36 +00:00
quota-classes-update-response.json [api-ref] Add api-ref for os-quota-class-sets APIs 2017-08-08 13:02:36 +00:00
quotas-show-defaults-response.json [Api-ref] Update quota-set APIs ref 2017-06-29 09:22:22 +08:00
quotas-show-response.json [Api-ref] Update quota-set APIs ref 2017-06-29 09:22:22 +08:00
quotas-show-usage-response.json Add API document for quota usage. 2017-08-01 15:39:01 +08:00
quotas-update-request.json [Api-ref] Update quota-set APIs ref 2017-06-29 09:22:22 +08:00
quotas-update-response.json [Api-ref] Update quota-set APIs ref 2017-06-29 09:22:22 +08:00
resource-filters-list-response.json Add 'resource_filters' API to support generalized filtering 2017-05-20 10:33:21 +08:00
services-disable-log-request.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-disable-log-response.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-disable-request.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-disable-response.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-enable-request.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-enable-response.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-failover-host-request.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-freeze-request.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-get-log-request.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-get-log-response.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-list-response.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-set-log-request.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
services-thaw-request.json Api-ref: add 'os-services' v3 api doc 2017-08-23 13:34:52 +08:00
snapshot-create-request.json Add params for API v3 snapshot-create 2017-07-06 07:06:52 +00:00
snapshot-create-response.json Merge "Add params for API v3 snapshot-create" 2017-07-09 15:40:53 +00:00
snapshot-manage-list-detail-response.json api-ref: add list manageable resource API 2017-05-23 09:51:28 +08:00
snapshot-manage-list-response.json api-ref: add list manageable resource API 2017-05-23 09:51:28 +08:00
snapshot-manage-request.json api-ref: add list manageable resource API 2017-05-23 09:51:28 +08:00
snapshot-metadata-create-request.json [api-ref] Update snapshot/volume's metadata api-ref 2017-03-27 14:33:05 +08:00
snapshot-metadata-create-response.json [api-ref] Update snapshot/volume's metadata api-ref 2017-03-27 14:33:05 +08:00
snapshot-metadata-show-key-response.json [api-ref] Add snapshot metadata key api 2017-06-19 11:27:22 +08:00
snapshot-metadata-show-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
snapshot-metadata-update-key-request.json [api-ref] Add snapshot metadata key api 2017-06-19 11:27:22 +08:00
snapshot-metadata-update-key-response.json [api-ref] Add snapshot metadata key api 2017-06-19 11:27:22 +08:00
snapshot-metadata-update-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
snapshot-metadata-update-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
snapshot-show-response.json Show user_id when cinder snapshot-show 2017-06-27 22:33:33 -04:00
snapshot-status-reset-request.json Fix Reset a snapshot's status API Request Example 2017-09-30 14:07:48 +00:00
snapshot-update-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
snapshot-update-response.json Show user_id when cinder snapshot-show 2017-06-27 22:33:33 -04:00
snapshots-list-detailed-response.json Support count info in List&Detail APIs 2017-10-25 08:43:47 +00:00
snapshots-list-response.json Support count info in List&Detail APIs 2017-10-25 08:43:47 +00:00
user-quotas-show-response.json Api-ref: change 'tenant' to 'project' in v2 doc 2017-09-27 18:14:25 +08:00
user-quotas-update-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
user-quotas-update-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
version-show-response.json Replace http with https for doc links in cinder 2017-10-17 11:14:01 +08:00
versions-response.json Replace http with https for doc links in cinder 2017-10-17 11:14:01 +08:00
volume-attach-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-bootable-status-update-request.json [api-ref]Adds API documentation for 'os-set_bootable' action 2017-06-04 07:44:47 -04:00
volume-create-request.json Clean up repl v1 volume creation from replication 2017-08-07 11:09:22 -05:00
volume-create-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-detach-request.json Add API documentation for volume detach in v3. 2017-03-15 07:15:02 +08:00
volume-extend-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-force-delete-request.json Add API documentation for force-delete volume in v2 and v3. 2017-05-19 15:52:17 +08:00
volume-force-detach-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-image-metadata-set-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-image-metadata-unset-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-manage-list-detail-response.json api-ref: add list manageable resource API 2017-05-23 09:51:28 +08:00
volume-manage-list-response.json api-ref: add list manageable resource API 2017-05-23 09:51:28 +08:00
volume-manage-request-cluster.json Support A/A on Scheduler operations 2016-12-14 17:48:28 +01:00
volume-manage-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-manage-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-metadata-create-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-metadata-create-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-metadata-show-key-response.json [api-ref] Update volume metadata key api 2017-06-19 01:28:27 +00:00
volume-metadata-show-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-metadata-update-key-request.json [api-ref] Update volume metadata key api 2017-06-19 01:28:27 +00:00
volume-metadata-update-key-response.json [api-ref] Update volume metadata key api 2017-06-19 01:28:27 +00:00
volume-metadata-update-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-metadata-update-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-os-retype-request.json Add missing retype API documentation 2017-05-18 11:47:20 +08:00
volume-revert-to-snapshot-request.json Cinder volume revert to snapshot 2017-06-21 10:35:32 +08:00
volume-show-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-status-reset-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-transfer-accept-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-transfer-accept-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-transfer-create-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-transfer-create-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-transfer-show-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-transfers-list-detailed-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-transfers-list-response.json [Api-ref]: Add missing key/values in the json files. 2017-09-05 14:17:12 +00:00
volume-type-access-add-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-type-access-delete-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-type-access-list-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-type-all-extra-specs-show-response.json Add v3 api-ref for showing all/specific extra specs for a volume type 2017-10-13 23:18:21 +08:00
volume-type-create-request.json Add params for v3 API volume-type-create 2017-06-23 18:06:02 +08:00
volume-type-create-response.json Add params for v3 API volume-type-create 2017-06-23 18:06:02 +08:00
volume-type-extra-specs-create-update-request.json Fix v3 api-ref for updating extra specs of volume type 2017-09-28 12:45:45 +00:00
volume-type-extra-specs-create-update-response.json Fix v3 api-ref for updating extra specs of volume type 2017-09-28 12:45:45 +00:00
volume-type-show-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-type-show-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-type-specific-extra-specs-show-response.json Add v3 api-ref for showing all/specific extra specs for a volume type 2017-10-13 23:18:21 +08:00
volume-type-specific-extra-specs-update-request.json Add v3 api-ref for updating specific extra specs for a volume type 2017-10-17 17:46:39 +08:00
volume-type-specific-extra-specs-update-response.json Add v3 api-ref for updating specific extra specs for a volume type 2017-10-17 17:46:39 +08:00
volume-type-update-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-types-list-response.json [Api-ref]: Add missing key/values in the json files. 2017-09-05 14:17:12 +00:00
volume-unmanage-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-update-request.json api-ref: Make v3 enclosing objects consistent 2017-09-01 09:54:34 -05:00
volume-update-response.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-upload-to-image-request.json Api-ref: Add upload-to-image api-ref 2017-06-29 09:19:10 +08:00
volume-upload-to-image-response.json Api-ref: Add upload-to-image api-ref 2017-06-29 09:19:10 +08:00
volumes-list-detailed-response.json Support count info in List&Detail APIs 2017-10-25 08:43:47 +00:00
volumes-list-response.json Support count info in List&Detail APIs 2017-10-25 08:43:47 +00:00
volumes-list-summary-response.json Use 'min_version' to mark newly added parameters in DOC 2017-06-29 17:33:13 +08:00
worker-cleanup-request.json [Api-ref] Add worker cleanup for service docs api 2017-08-16 03:21:48 +00:00
worker-cleanup-response.json [Api-ref] Add worker cleanup for service docs api 2017-08-16 03:21:48 +00:00