openstack/api-site
Code Issues Proposed changes

Merge "Add information about optional "id" attribute for create image"

Browse Source
This commit is contained in:
Jenkins 2015-12-08 06:00:36 +00:00 committed by Gerrit Code Review
commit 9484e6b723
3 changed files with 43 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl
View File

@ -161,21 +161,21 @@
on tags or anything defined as a <code>link</code> in the json-
schema, such as self, file, or schema.
</para>
<para>You can use the <code>size_min</code> and
<code>size_max</code> query parameters to perform
greater-than and less-than filtering of images based
on their <code>size</code> attribute. The size is
measured in bytes and refers to the size of an image
when it is stored on disk.
<para>
You can use the <code>size_min</code> and <code>size_max</code>
query parameters to perform greater-than and less-than filtering
of images based on their <code>size</code> attribute. The size is
measured in bytes and refers to the size of an image when it is
stored on disk.
</para>
<para>For example, sending a <code>size_min</code> filter
of 1048576 and <code>size_max</code> of 4194304
filters the container to include only images that are
between 1 and 4 MB.
<para>
For example, sending a <code>size_min</code> filter of 1048576 and
<code>size_max</code> of 4194304 filters the container to include
only images that are between 1 and 4 MB.
</para>
<para>You can see a list of VM images which status is in
<code>active</code>, <code>queued</code>, or
<code>saving</code>.
<para>
You can list VM images that have a status of <code>active</code>,
<code>queued</code>, or <code>saving</code>.
</para>
<para>
You can use query parameters to sort the results of this operation.
@ -292,7 +292,20 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The image ID.
A unique, user-defined image UUID, in the format:
</para>
<programlisting>nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn</programlisting>
<para>
Where <emphasis>n</emphasis> is a hexadecimal digit from 0
to f (or F).
</para>
<para>
For example:
</para>
<programlisting>b2173dd3-7ad6-4362-baa6-a68bce3565cb</programlisting>
<para>
If you omit this value, the API generates a UUID for the new
image.
</para>
</wadl:doc>
</param>

13
api-ref/src/wadls/image-api/src/v2/samples/image-create-req.json
View File

@ -1,13 +1,6 @@
{
"name": "Ubuntu 12.10",
"tags": [
"ubuntu",
"quantal"
],
"container_format": "bare",
"disk_format": "qcow2",
"visibility": "private",
"min_disk": 0,
"protected": false,
"min_ram": 0
"disk_format": "raw",
"name": "Ubuntu",
"id": "b2173dd3-7ad6-4362-baa6-a68bce3565cb"
}

29
api-ref/src/wadls/image-api/src/v2/samples/image-create-response.json
View File

@ -1,24 +1,21 @@
{
"status": "queued",
"name": "Ubuntu 12.10",
"tags": [
"ubuntu",
"quantal"
],
"name": "Ubuntu",
"tags": [],
"container_format": "bare",
"created_at": "2014-11-11T20:47:55Z",
"disk_format": "qcow2",
"updated_at": "2014-11-11T20:47:55Z",
"created_at": "2015-11-29T22:21:42Z",
"size": null,
"disk_format": "raw",
"updated_at": "2015-11-29T22:21:42Z",
"visibility": "private",
"self": "/v2/images/b2173dd3-7ad6-4362-baa6-a68bce3565ca",
"self": "/v2/images/b2173dd3-7ad6-4362-baa6-a68bce3565cb",
"min_disk": 0,
"protected": false,
"id": "b2173dd3-7ad6-4362-baa6-a68bce3565ca",
"file": "/v2/images/b2173dd3-7ad6-4362-baa6-a68bce3565ca/file",
"owner": "b4eedccc6fb74fa8a7ad6b08382b852b",
"min_ram": 0,
"schema": "/v2/schemas/image",
"size": null,
"id": "b2173dd3-7ad6-4362-baa6-a68bce3565cb",
"file": "/v2/images/b2173dd3-7ad6-4362-baa6-a68bce3565cb/file",
"checksum": null,
"virtual_size": null
"owner": "bab7d5c60cd041a0a36f7c4b6e1dd978",
"virtual_size": null,
"min_ram": 0,
"schema": "/v2/schemas/image"
}