api-ref: avoid mushy wording around server.image description

This disambiguates the description on the server.image parameter.
If the server is booted from volume (where boot from volume means
there is a bdm with boot_index=0 and destination_type=volume),
then the server.image will be an empty string [1] otherwise it
will be a dict.

[1] 2f0f8b8cf1/nova/api/openstack/compute/views/servers.py (L540)

Change-Id: Ia1ecd39a5636fa5a35cdbcafc03828b2925a9033
This commit is contained in:
Matt Riedemann 2019-12-13 12:36:17 -05:00
parent 2f0f8b8cf1
commit 685dc60d58
1 changed files with 1 additions and 1 deletions

View File

@ -3832,7 +3832,7 @@ hypervisors:
image:
description: |
The UUID and links for the image for your server instance. The ``image`` object
might be an empty string when you boot the server from a volume.
will be an empty string when you boot the server from a volume.
in: body
required: true
type: object