openstack/glance
Code Issues Proposed changes

Update api-ref to add newly supported 'vhdx' disk format option.

Browse Source 
Images API reference is updated to reflect that the 'vhdx'
disk_format is now one of the default formats supported by Glance.
This change also introduces substitution of image parameter
description from a single source file in order to avoid copy and
paste errors. Only the disk_format parameter is affected in this,
other parameters may be consolidated in subsequent patch(es).

Co-Authored-By: Anne Gentle <agentle@cisco.com>
Co-Authored-By: Andreas Jaeger <jaegerandi@gmail.com>
Co-Authored-By: Alexander Bashmakov <alexander.bashmakov@intel.com>

Change-Id: Ib50b8e184364b6ee7d8af4ed3d4959ba76568049
Spec-Lite: https://review.openstack.org/#/c/347626
Closes-Bug: #1608643
This commit is contained in:
Alexander Bashmakov 2016-08-17 13:16:10 -07:00
parent 8cd0f87efb
commit 3a1f861620
5 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
api-ref/source/v2/images-parameters-descriptions.inc Normal file
View File

@ -0,0 +1,17 @@
.. |p-start| raw:: html
<p>
.. |p-end| raw:: html
</p>
.. |disk_format_description| replace::
|p-start|\ The format of the disk.\ |p-end|
|p-start|\ Responses may vary based on the configuration available in a
particular OpenStack cloud. See the :ref:`Image Schema <image-schema>`
response from the cloud itself for the valid values available.\ |p-end|
|p-start|\ Example formats are: ``ami``, ``ari``, ``aki``, ``vhd``,
``vhdx``, ``vmdk``, ``raw``, ``qcow2``, ``vdi``, or ``iso``.\ |p-end|
|p-start|\ The value might be ``null`` (JSON null data type).\ |p-end|
**Newton changes**: The ``vhdx`` disk format is a supported value.

7
api-ref/source/v2/images-parameters.yaml
View File

@ -290,16 +290,13 @@ direct_url:
type: string
disk_format:
description: |
The format of the disk. A valid value is ``ami``, ``ari``, ``aki``,
``vhd``, ``vmdk``, ``raw``, ``qcow2``, ``vdi``, or ``iso``. The value
might be ``null`` (JSON null data type).
|disk_format_description|
in: body
required: true
type: enum
disk_format-in-request:
description: |
The format of the disk. A valid value is ``ami``, ``ari``, ``aki``,
``vhd``, ``vmdk``, ``raw``, ``qcow2``, ``vdi``, or ``iso``.
|disk_format_description|
in: body
required: false
type: enum

1
api-ref/source/v2/index.rst
View File

@ -22,6 +22,7 @@ Image Service API v2 (CURRENT)
.. rest_expand_all::
.. include:: images-parameters-descriptions.inc
.. include:: images-images-v2.inc
.. include:: images-sharing-v2.inc
.. include:: images-tags.inc

1
api-ref/source/v2/samples/schemas-image-show-response.json
View File

@ -67,6 +67,7 @@
"ari",
"aki",
"vhd",
"vhdx",
"vmdk",
"raw",
"qcow2",

1
api-ref/source/v2/samples/schemas-images-list-response.json
View File

@ -88,6 +88,7 @@
"ari",
"aki",
"vhd",
"vhdx",
"vmdk",
"raw",
"qcow2",