openstack
/
glance
Code Issues Proposed changes

api-ref: update container_format, disk_format 

This patch updates the disk_format description to include "ploop"
(added in Ocata).  It also rewrites the container_format description
to indicate that the actual values depend on how the API being queried
is configured.

This patch does not update the api-ref for the deprecated v1 API.

Change-Id: I3385b3f628b74b109c05108e331085c54b0126a1
This commit is contained in:
Brian Rosmaita 2017-08-03 18:44:11 -04:00
parent e7ceaebd49
commit 08cd24d28c
2 changed files with 23 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
api-ref/source/v2/images-parameters-descriptions.inc
View File

@ -6,12 +6,30 @@
</p>
.. |html-br| raw:: html
<br />
.. |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
|p-start|\ Values 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|
``vhdx``, ``vmdk``, ``raw``, ``qcow2``, ``vdi``, ``ploop`` or
``iso``.\ |p-end|
|p-start|\ The value might be ``null`` (JSON null data type).\ |p-end|
|p-start|\
**Newton changes**: The ``vhdx`` disk format is a supported
value.\ |html-br|
**Ocata changes**: The ``ploop`` disk format is a supported
value.\ |p-end|
.. |container_format_description| replace::
|p-start|\ Format of the image container.\ |p-end|
|p-start|\ Values 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``, ``bare``,
``ovf``, ``ova``, or ``docker``.\ |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.

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

@ -256,17 +256,13 @@ checksum:
type: string
container_format:
description: |
Format of the image container. A valid value is one of
``ami``, ``ari``, ``aki``, ``bare``, ``ovf``, ``ova``, or
``docker``. The value might be ``null`` (JSON null data type).
|container_format_description|
in: body
required: true
type: enum
container_format-in-request:
description: |
Format of the image container. A valid value is one of
``ami``, ``ari``, ``aki``, ``bare``, ``ovf``, ``ova``, or
``docker``.
|container_format_description|
in: body
required: false
type: enum