Improving the description for unshelve request body

The 'availability_zone' description in unshelve api-ref is confusing,
adding NOTE for unshelve request body:

Since microversion 2.77, allowed request body schema are {"unshelve":
null} or {"unshelve": {"availability_zone": <string>}}. A request body
of {"unshelve":{}} is not allowed.

Closes-Bug: #1908336
Change-Id: I66c209baf11c37ffebca52764263daae9e1dd50b
This commit is contained in:
zhangbailin 2020-12-16 01:47:07 +00:00 committed by Brin Zhang
parent 6c96602864
commit b4f560d4e1
1 changed files with 4 additions and 0 deletions

View File

@ -143,6 +143,10 @@ Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNo
Request
-------
.. note:: Since microversion 2.77, allowed request body schema are
{"unshelve": null} or {"unshelve": {"availability_zone": <string>}}.
A request body of {"unshelve": {}} is not allowed.
.. rest_parameters:: parameters.yaml
- server_id: server_id_path