diff options
| author | Jenkins <jenkins@review.openstack.org> | 2017-03-28 17:33:25 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2017-03-28 17:33:25 +0000 |
| commit | ca06a09d4d900f6196eeefb1cbfcef462c12b39c (patch) | |
| tree | 1c2b6e068a5a9ec81272b9136a8d51bf3bb92a22 /doc | |
| parent | dd81ca0692ebe6c4892271da60a1e5eceba8d25c (diff) | |
| parent | 709eac73fbf0691d8012052773eec73006adf704 (diff) | |
| download | python-openstackclient-ca06a09d4d900f6196eeefb1cbfcef462c12b39c.tar.gz | |
Merge "Fix volume transfers request commands"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/backwards-incompatible.rst | 11 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-transfer-request.rst | 21 |
2 files changed, 22 insertions, 10 deletions
diff --git a/doc/source/backwards-incompatible.rst b/doc/source/backwards-incompatible.rst index 4f38aa54..bce86717 100644 --- a/doc/source/backwards-incompatible.rst +++ b/doc/source/backwards-incompatible.rst @@ -16,6 +16,17 @@ this backwards incompatible change handling. Backwards Incompatible Changes ============================== +.. Carry this section as comments until 4.0 release +.. Release 4.0 +.. ----------- + +.. 1. Change ``volume transfer request accept`` to use new option ``--auth-key`` +.. rather than a second positional argument. + +.. * As of: 4.0 +.. * Remove in: <5.0> +.. * Commit: <tbd> + Release 3.0 ----------- diff --git a/doc/source/command-objects/volume-transfer-request.rst b/doc/source/command-objects/volume-transfer-request.rst index 77c36429..23cd3d3e 100644 --- a/doc/source/command-objects/volume-transfer-request.rst +++ b/doc/source/command-objects/volume-transfer-request.rst @@ -13,17 +13,19 @@ Accept volume transfer request .. code:: bash openstack volume transfer request accept - <transfer-request> - <auth-key> + --auth-key <key> + <transfer-request-id> -.. _volume_transfer_request_accept: -.. describe:: <transfer-request> +.. option:: --auth-key <key> - Volume transfer request to accept (name or ID) + Volume transfer request authentication key + +.. _volume_transfer_request_accept: +.. describe:: <transfer-request-id> -.. describe:: <auth-key> + Volume transfer request to accept (ID only) - Authentication key of transfer request + Non-admin users are only able to specify the transfer request by ID. volume transfer request create ------------------------------ @@ -65,7 +67,7 @@ Delete volume transfer request(s) volume transfer request list ---------------------------- -Lists all volume transfer requests. +Lists all volume transfer requests .. program:: volume transfer request list .. code:: bash @@ -75,8 +77,7 @@ Lists all volume transfer requests. .. option:: --all-projects - Shows detail for all projects. Admin only. - (defaults to False) + Include all projects (admin only) volume transfer request show ---------------------------- |