openstack
/
cinder
Code Issues Proposed changes
cinder/api-ref/source/v3/samples
History
Gorka Eguileor dab5df1747 Update volume api microversion doc and tests 
We have many microversions but we but we haven't kept the samples, docs,
and tests up to date with them.

Of the many microversions this patch will focus on the ones that have
updated the fields returned for volumes updating the docs, adding the
appropriate json samples, updating the tests, and updating the
contributor docs to highlight the need to keep these up to date.

Some convenience methods have been added to facilitate the testing:

- use_versions: class decorator that allows us to run the same tests
  with different microversions, each using their respective json and
  templates.

- override_mv: method decorator to change the microversion in a single
  test.

- common_api_sample: context manager to use the base sample instead of a
  microversion specific one.

Change-Id: Ide303685a4cd1477c319b36e67a3b05c8d129126
 		2021-05-31 12:41:46 +02:00
..
extensions Add OS-SCH-HNT in extensions list 2019-06-07 08:38:06 +05:30
limits Automate generation of qos specs api-ref samples 2019-09-27 17:43:40 +05:30
qos Automate generation of qos specs api-ref samples 2019-09-27 17:43:40 +05:30
quota_classes Automate generation of quotas api-ref samples 2019-09-30 16:29:49 +05:30
quota_sets Automate generation of quotas api-ref samples 2019-09-30 16:29:49 +05:30
snapshot_manage_extensions Automate generation of volume transfer api-ref samples 2019-03-20 16:05:20 +05:30
snapshots Automate generation of snapshots api-ref samples 2019-03-12 12:07:01 +05:30
versions Add encryption_key_id to volume and backup details 2021-02-04 07:23:08 -08:00
volume_actions Automate generation of volume actions api-ref samples 2019-02-08 01:13:03 +05:30
volume_manage_extensions Automate generation of volume transfer api-ref samples 2019-03-20 16:05:20 +05:30
volume_transfer Automate generation of volume transfer api-ref samples 2019-03-20 16:05:20 +05:30
volume_type Fix functional jobs 2021-05-25 16:55:05 +02:00
volumes Update volume api microversion doc and tests 2021-05-31 12:41:46 +02:00
attachment-complete.json Fix v3 sample files 2018-06-22 01:05:08 +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 Fix v3 sample files 2018-06-22 01:05:08 +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 Support cross AZ backups 2018-02-23 11:35:42 +01: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 Fix json formatting eror 2017-12-12 17:26:33 +08:00
backup-show-response.json Add user_id in backup list and show API 2018-12-12 00:52:05 -05: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 Add user_id in backup list and show API 2018-12-12 00:52:05 -05:00
backups-list-response.json api-ref: fix response example of list-backups 2018-11-07 09:28:08 +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
get-default-type-response.json Default type overrides 2020-09-16 14:05:31 +00:00
get-default-types-response.json Default type overrides 2020-09-16 14:05:31 +00:00
group-create-from-src-request.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
group-create-from-src-response.json api-ref: add missing response body for groups 2018-09-29 17:24:11 +08:00
group-create-request.json Fix json data format 2018-02-07 16:57:15 +08:00
group-create-response.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-delete-request.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
group-replication-disable.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
group-replication-enable.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
group-replication-failover.json api-ref: Add group replication APIs 2017-08-27 09:49:19 -05:00
group-replication-list-targets.json Fix v3 sample files 2018-06-22 01:05:08 +08: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 project_id in group list and show API 2019-01-30 13:20:58 +05:30
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 Fix json data format 2018-02-07 16:57:15 +08:00
group-snapshots-create-response.json Fix api-ref for group snapshots API 2017-10-31 15:25:22 +08:00
group-snapshots-list-detailed-response.json Add project_id in group snapshots list and show API 2019-03-01 22:59:19 +05:30
group-snapshots-list-response.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
group-snapshots-show-response.json Add project_id in group snapshots list and show API 2019-03-01 22:59:19 +05:30
group-type-create-request.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
group-type-default-response.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
group-type-show-response.json Fix v3 sample files 2018-06-22 01:05:08 +08: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-request.json Fix api-ref for v3 group type specs 2017-12-06 11:59:48 +08: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 Fix api-ref for v3 volume group types 2018-01-18 08:56:17 +00:00
group-types-list-response.json api-ref: add missing fields in volume group types 2018-10-17 03:04:01 +00:00
group-update-request.json Add API Reference for groups 2016-08-02 18:04:58 -04:00
groups-list-detailed-response.json Add project_id in group list and show API 2019-01-30 13:20:58 +05:30
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
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 api-ref: total/free_capacity should be with postfix _gb 2018-09-28 15:30:37 +08:00
quota-classes-show-response.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
quota-classes-update-request.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
quota-classes-update-response.json Fix v3 sample files 2018-06-22 01:05:08 +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 Fix v3 sample files 2018-06-22 01:05:08 +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
set-default-type-request.json Default type overrides 2020-09-16 14:05:31 +00:00
set-default-type-response.json Default type overrides 2020-09-16 14:05:31 +00:00
snapshot-force-delete-request.json Add v3 api-ref for force delete snapshot 2018-06-21 23:34:16 +08:00
snapshot-manage-list-detail-response.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
snapshot-manage-list-response.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
snapshot-status-reset-request.json Fix Reset a snapshot's status API Request Example 2017-09-30 14:07:48 +00:00
snapshot-status-update-request.json Add v3 api-ref for updating snapshot status 2018-06-20 19:13:58 +08: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
volume-attach-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-begin-detaching-request.json Fix v3 sample files 2018-06-22 01:05:08 +08: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-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 Fix v3 sample files 2018-06-22 01:05:08 +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-image-metadata-update-response.json api-ref: add response body for set-image-metadata-for-a-volume 2018-12-10 10:19:17 +08:00
volume-initialize-connection-request.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
volume-manage-list-detail-response.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
volume-manage-list-response.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
volume-manage-request-cluster.json Support A/A on Scheduler operations 2016-12-14 17:48:28 +01:00
volume-os-migrate_volume-request.json api-ref: add docs for os-migrate_volume API 2018-08-22 20:38:22 -04:00
volume-os-migrate_volume_completion-request.json docs: Add os-migrate_volume_completion api-ref 2019-02-20 11:40:30 +00:00
volume-os-retype-request.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
volume-readonly-update-request.json api-ref: Adds os-update_readonly_flag API 2018-06-21 04:38:16 +00:00
volume-reserve-request.json Add missing volume APIs 2018-05-15 20:15:49 +08:00
volume-revert-to-snapshot-request.json Cinder volume revert to snapshot 2017-06-21 10:35:32 +08:00
volume-roll-detaching-request.json Add missing volume APIs 2018-05-15 20:15:49 +08:00
volume-status-reset-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-terminate-connection-request.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
volume-type-access-delete-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-unmanage-request.json Create v3 API Reference 2016-09-19 14:33:01 -04:00
volume-unreserve-request.json Add missing volume APIs 2018-05-15 20:15:49 +08:00
worker-cleanup-request.json Fix v3 sample files 2018-06-22 01:05:08 +08:00
worker-cleanup-response.json [Api-ref] fix the type of service_id in worker cleanup api 2018-05-29 14:19:14 +08:00