cinder/api-ref/source/v2
Matt Riedemann c549325bd2 api-ref: mark migration_status parameter as optional
Everything that goes through the volumes view builder
detail() method has a strict is_admin check on returning
the migration_status parameter [1]. This means the
migration_status parameter in the API reference should
be optional since it's admin-only and not always shown.

This fixes the v2 and v3 API references for showing,
creating, updating, resetting the status of, and creating
from a managed volume. As a result, the parameter for a
required migration_status parameter is unused and removed.

Note that there is no strict policy check on the
migration_status request parameter when resetting a volume's
status, but the action itself is admin-only by default
using the volume_extension:volume_admin_actions:reset_status
policy rule.

[1] https://opendev.org/openstack/cinder/src/tag/14.0.0/cinder/api/v2/views/volumes.py#L94

Change-Id: I82308dc1a6aaf039b675a17e19747f11be574209
Closes-Bug: #1828113
2019-05-09 09:31:02 -04:00
..
samples docs: Add os-migrate_volume_completion api-ref 2019-02-20 11:40:30 +00:00
api-versions.inc Fix api-ref response code title levels 2018-03-13 15:57:54 -05:00
capabilities-v2.inc api-ref: Fix namespace parameter for backend capabilities 2018-10-06 00:28:09 -04:00
consistencygroups-v2.inc Doc8: Stop skipping D001: Line too long 2019-02-19 16:51:56 -06:00
ext-backups-actions-v2.inc Doc8: Stop skipping D001: Line too long 2019-02-19 16:51:56 -06:00
ext-backups.inc Add missing backup status in API doc 2019-01-04 07:05:25 +00:00
hosts.inc api-ref: Correct response body type for show host details 2018-11-02 09:53:21 -04:00
index.rst Fix api-ref title levels and index 2018-08-15 08:18:28 -05:00
limits.inc Fix api-ref response code title levels 2018-03-13 15:57:54 -05:00
os-cgsnapshots-v2.inc api-ref: Correct the cgsnapshot_id parameter 2018-04-26 17:08:32 +00:00
os-vol-pool-v2.inc api-ref: total/free_capacity should be with postfix _gb 2018-09-28 15:30:37 +08:00
os-vol-transfer-v2.inc api-ref: add preconditions for volume transfer APIs 2018-09-11 17:43:05 -04:00
parameters.yaml api-ref: mark migration_status parameter as optional 2019-05-09 09:31:02 -04:00
qos-specs-v2-qos-specs.inc Fix api-ref title levels and index 2018-08-15 08:18:28 -05:00
quota-classes.inc Doc8: Stop skipping D001: Line too long 2019-02-19 16:51:56 -06:00
quota-sets.inc Doc8: Stop skipping D001: Line too long 2019-02-19 16:51:56 -06:00
volume-manage.inc Doc8: Stop skipping D001: Line too long 2019-02-19 16:51:56 -06:00
volume-type-access.inc Doc8: Stop skipping D001: Line too long 2019-02-19 16:51:56 -06:00
volumes-v2-extensions.inc api-ref: Change extensions updated type to updated_at 2018-09-30 10:25:46 -04:00
volumes-v2-snapshots-actions.inc Fix api-ref title levels and index 2018-08-15 08:18:28 -05:00
volumes-v2-snapshots.inc Doc8: Stop skipping D001: Line too long 2019-02-19 16:51:56 -06:00
volumes-v2-types.inc Doc8: Stop skipping D001: Line too long 2019-02-19 16:51:56 -06:00
volumes-v2-versions.inc Fix api-ref response code title levels 2018-03-13 15:57:54 -05:00
volumes-v2-volumes-actions.inc Merge "[api-ref] Fix the parameter of image metadata" 2019-02-28 16:58:09 +00:00
volumes-v2-volumes.inc Doc8: Stop skipping D001: Line too long 2019-02-19 16:51:56 -06:00