backups api reference description is misleading wrt attached volumes

[Matt Riedemann]

The API reference description for volume backups:

https://developer.openstack.org/api-ref/block-storage/v3/#backups-backups

Says:

"Backup and restore operations can only be carried out on volumes that are in an unattached and available state."

But that's not totally true, but with the create backup API you can specify the force flag to backup an in-use volume:

https://developer.openstack.org/api-ref/block-storage/v3/?expanded=create-a-backup-detail#create-a-backup

"force (Optional) body boolean Indicates whether to backup, even if the volume is attached. Default is false. See valid boolean values"

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/612755

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/612755
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=6b852e859fc73e4b8a9e355286a6c404b10d701b
Submitter: Zuul
Branch: master

commit 6b852e859fc73e4b8a9e355286a6c404b10d701b
Author: Matt Riedemann <email address hidden>
Date: Tue Oct 23 12:54:36 2018 -0400

    api-ref: cleanup status conditions for backup/restore APIs

    The description for the backups API in both the v2 and v3
    reference had a generic statement that only available volumes
    can be backed up and restored, which is misleading since it
    is possible to backup an in-use volume if the force parameter
    is used.

    This change drops the generic statement from the high-level
    description and opts for per-API descriptions about the status
    preconditions for backup and restore operations.

    The v3 restore reference already mentioned the status precondition
    so the only change to that is fixing the bullet list formatting.

    Change-Id: Ib6c61af9ced2527884569fa15a848a215dd985b8
    Closes-Bug: #1799499

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/cinder 14.0.0.0rc1 release candidate.