openstack
/
nova
Code Issues Proposed changes

api-ref: Add a description of 'key_name' in rebuild 

In rebuild operation, users can unset the existing keypair
by setting 'key_name' to 'null' in a request body.
(The function has been added in
I23886a89c25f811cfbe7e2500ce7ff52f9162966).

But it is not described obviously in API reference.
So add an additional description in API reference.

Change-Id: I2d1b8eddd8555ad6896541b308895dc537686168
This commit is contained in:
Takashi NATSUME 2017-11-15 16:10:38 +09:00
parent 8fd4f9a029
commit 5444e7ff3a
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api-ref/source/parameters.yaml
View File

@ -3528,7 +3528,8 @@ key_name:
type: string
key_name_rebuild_req:
description: |
Key pair name for rebuild API.
Key pair name for rebuild API. If ``null`` is specified,
the existing keypair is unset.
.. note:: Users within the same project are able to rebuild other
user's instances in that project with a new keypair. Keys