summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorMatt Riedemann <mriedem.os@gmail.com>2019-12-13 12:36:17 -0500
committerMatt Riedemann <mriedem.os@gmail.com>2019-12-13 12:39:01 -0500
commit685dc60d5848211d7ccfa208346f1f7d18e5d706 (patch)
tree1482fbb82836470ddeec6e4966aa1602359d7b7e /api-ref
parent2f0f8b8cf13b7441ce6a7a524b33d30d40f1d468 (diff)
downloadnova-685dc60d5848211d7ccfa208346f1f7d18e5d706.tar.gz
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] https://github.com/openstack/nova/blob/2f0f8b8cf13b7441ce6a7a524b33d30d40f1d468/nova/api/openstack/compute/views/servers.py#L540 Change-Id: Ia1ecd39a5636fa5a35cdbcafc03828b2925a9033
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/parameters.yaml2
1 files changed, 1 insertions, 1 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 8401601740..d21c3caf00 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -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