OpenStack Image V2 API documentation

Changed None values to null

Change-Id: I9e926c9f91004e7631d9ab6d58ad1f85758d22c0
Closes-Bug: #1481512
This commit is contained in:
Ilya Sviridov 2015-08-10 10:53:28 -07:00 committed by Diane Fleming
parent 3f6780f113
commit 94cfc6e221
7 changed files with 35 additions and 34 deletions

View File

@ -30,8 +30,9 @@
<title>Images</title> <title>Images</title>
<para>Creates, lists, updates, and deletes images.</para> <para>Creates, lists, updates, and deletes images.</para>
<para> <para>
Image operations show all fields in the response body. For any Image operations show all fields in the response body. Any field
field with no value, the response body shows <code>None</code>. with no value is set to <code>null</code> value (JSON null data
type).
</para> </para>
<para> <para>
The possible status values for images are: The possible status values for images are:

View File

@ -189,11 +189,9 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para> <para>
Sorts by one or more attribute and sort direction combinations. You can Sorts by one or more attribute and sort direction combinations. You can
also set multiple sort keys and directions. Default direction is also set multiple sort keys and directions. Default direction is
<code>desc</code>. <code>desc</code>.
</para> </para>
<para>For example:</para> <para>For example:</para>
<programlisting language="json">GET /v2/images?sort=name:asc,status:desc</programlisting> <programlisting language="json">GET /v2/images?sort=name:asc,status:desc</programlisting>
@ -238,8 +236,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name of the image.</para> <para>The name of the image.</para>
<para>If this field has no value, its <para>
value is <code>None</code>. If this field has no value, its value is <code>null</code> (JSON null data type).
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -252,8 +250,8 @@
<para> <para>
The container format of image. The container format of image.
</para> </para>
<para>If this field has no value, its <para>
value is <code>None</code>. If this field has no value, its value is <code>null</code> (JSON null data type).
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -274,7 +272,7 @@
The disk format of the image. The disk format of the image.
</para> </para>
<para> <para>
If this field has no value, its value is <code>None</code>. If this field has no value, its value is <code>null</code> (JSON null data type).
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -291,9 +289,11 @@
style="plain" required="true" type="xsd:int"> style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The minimum disk size in GB that is required to boot the image.</para>
<para> <para>
If this field has no value, its value is <code>None</code>. The minimum disk size in GB that is required to boot the image.
</para>
<para>
If this field has no value, its value is <code>null</code> (JSON null data type).
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -319,8 +319,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The minimum amount of RAM in MB that is required to boot the image.</para> <para>The minimum amount of RAM in MB that is required to boot the image.</para>
<para>If this field has no value, its <para>
value is <code>None</code>. If this field has no value, its value is <code>null</code> (JSON null data type).
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -332,8 +332,8 @@
<para>Hash of the image data used. The Image service uses this value for <para>Hash of the image data used. The Image service uses this value for
verification. verification.
</para> </para>
<para>If this field has no value, its <para>
value is <code>None</code>. If this field has no value, its value is <code>null</code> (JSON null data type).
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -343,8 +343,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The ID of the owner, or tenant, of the image.</para> <para>The ID of the owner, or tenant, of the image.</para>
<para>If this field has no value, its <para>
value is <code>None</code>. If this field has no value, its value is <code>null</code> (JSON null data type).
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -362,8 +362,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The virtual size of the image.</para> <para>The virtual size of the image.</para>
<para>If this field has no value, its <para>
value is <code>None</code>. If this field has no value, its value is <code>null</code> (JSON null data type).
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -381,8 +381,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The size of the image data, in bytes.</para> <para>The size of the image data, in bytes.</para>
<para>If this field has no value, its <para>
value is <code>None</code>. If this field has no value, its value is <code>null</code> (JSON null data type).
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>

View File

@ -18,7 +18,7 @@
"owner": "b4eedccc6fb74fa8a7ad6b08382b852b", "owner": "b4eedccc6fb74fa8a7ad6b08382b852b",
"min_ram": 0, "min_ram": 0,
"schema": "/v2/schemas/image", "schema": "/v2/schemas/image",
"size": "None", "size": null,
"checksum": "None", "checksum": null,
"virtual_size": "None" "virtual_size": null
} }

View File

@ -17,5 +17,5 @@
"size": 13167616, "size": 13167616,
"min_ram": 0, "min_ram": 0,
"schema": "/v2/schemas/image", "schema": "/v2/schemas/image",
"virtual_size": "None" "virtual_size": null
} }

View File

@ -17,5 +17,5 @@
"size": 13167616, "size": 13167616,
"min_ram": 0, "min_ram": 0,
"schema": "/v2/schemas/image", "schema": "/v2/schemas/image",
"virtual_size": "None" "virtual_size": null
} }

View File

@ -19,7 +19,7 @@
"size": 13167616, "size": 13167616,
"min_ram": 0, "min_ram": 0,
"schema": "/v2/schemas/image", "schema": "/v2/schemas/image",
"virtual_size": "None" "virtual_size": null
}, },
{ {
"status": "active", "status": "active",
@ -40,7 +40,7 @@
"size": 476704768, "size": 476704768,
"min_ram": 0, "min_ram": 0,
"schema": "/v2/schemas/image", "schema": "/v2/schemas/image",
"virtual_size": "None" "virtual_size": null
} }
], ],
"schema": "/v2/schemas/images", "schema": "/v2/schemas/images",

View File

@ -14,10 +14,10 @@
"self": "/v2/images/da3b75d9-3f4a-40e7-8a2c-bfab23927dea", "self": "/v2/images/da3b75d9-3f4a-40e7-8a2c-bfab23927dea",
"file": "/v2/images/da3b75d9-3f4a-40e7-8a2c-bfab23927dea/file", "file": "/v2/images/da3b75d9-3f4a-40e7-8a2c-bfab23927dea/file",
"schema": "/v2/schemas/image", "schema": "/v2/schemas/image",
"owner": "None", "owner": null,
"min_ram": "None", "min_ram": null,
"min_disk": "None", "min_disk": null,
"disk_format": "None", "disk_format": null,
"virtual_size": "None", "virtual_size": null,
"container_format": "None" "container_format": null
} }