summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorzhangbailin <zhangbailin@inspur.com>2020-12-16 01:47:07 +0000
committerBrin Zhang <zhangbailin@inspur.com>2021-01-05 12:21:01 +0000
commitb4f560d4e193f457d2cd5724c62d2b6adcaf332b (patch)
treeb703acd0242e34856b2fd20e8c2e7b943b174952 /api-ref
parent6c96602864403123f99995773990287a256c833e (diff)
downloadnova-b4f560d4e193f457d2cd5724c62d2b6adcaf332b.tar.gz
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
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/servers-action-shelve.inc4
1 files changed, 4 insertions, 0 deletions
diff --git a/api-ref/source/servers-action-shelve.inc b/api-ref/source/servers-action-shelve.inc
index 4bb63ceb7e..08ca65dadd 100644
--- a/api-ref/source/servers-action-shelve.inc
+++ b/api-ref/source/servers-action-shelve.inc
@@ -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