openstack/api-site
Code Issues Proposed changes

Merge "Fix some description of image-create in Glance v2"

Browse Source
This commit is contained in:
Jenkins 2015-12-21 01:13:53 +00:00 committed by Gerrit Code Review
commit 78aad13796
3 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
api-ref/src/wadls/image-api/src/v2/common.ent
View File

@ -293,7 +293,9 @@
style="plain" required="true" type="csapi:UUID"> style="plain" required="true" type="csapi:UUID">
<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 UUID of the image.</para> <para>
The UUID of the image.
</para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY min_ramParameter ' <!ENTITY min_ramParameter '
@ -301,9 +303,12 @@
style="plain" required="true" type="csapi:UUID"> style="plain" required="true" type="csapi:UUID">
<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> <para>
If this field has no value, its value is <code>null</code> (JSON null data type). The minimum amount of RAM in MB 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>'>
@ -557,15 +562,15 @@
</param>'> </param>'>
<!ENTITY location_urlParameter ' <!ENTITY location_urlParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="url" style="plain" type="xsd:string" name="locations" style="plain" type="xsd:list"
required="true"> required="true">
<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" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>URL to access the image file kept in external store. It <para>
appears when you set the <code>show_multiple_locations</code> option A list of URLs to access the image file in external store. This list
to <code>True</code> in the Image service&apos;s configuration appears if the <code>show_multiple_locations</code> option is set to
file. <code>True</code> in the Image service&apos;s configuration file.
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -577,7 +582,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>URL to access the image file kept in external store. It <para>URL to access the image file kept in external store. It
appears when you set the <code>show_multiple_locations</code> option appears when you set the <code>show_image_direct_url</code> option
to <code>True</code> in the Image service&apos;s configuration to <code>True</code> in the Image service&apos;s configuration
file. file.
</para> </para>
@ -747,7 +752,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"
title="Namespace"> title="Namespace">
<para>Unique namespace.</para> <para>
The UUID of the namespace.
</para>
</wadl:doc> </wadl:doc>
</param>' > </param>' >
<!ENTITY metadefNamespaceParameter ' <!ENTITY metadefNamespaceParameter '
@ -1258,7 +1265,8 @@
style="plain" required="true" type="csapi:UUID" default="ALL"> style="plain" required="true" type="csapi:UUID" default="ALL">
<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 UUID of the task. <para>
The UUID of the task.
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>

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

@ -8,6 +8,7 @@
"disk_format": "raw", "disk_format": "raw",
"updated_at": "2015-11-29T22:21:42Z", "updated_at": "2015-11-29T22:21:42Z",
"visibility": "private", "visibility": "private",
"locations": [],
"self": "/v2/images/b2173dd3-7ad6-4362-baa6-a68bce3565cb", "self": "/v2/images/b2173dd3-7ad6-4362-baa6-a68bce3565cb",
"min_disk": 0, "min_disk": 0,
"protected": false, "protected": false,

9
api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl
View File

@ -235,13 +235,6 @@
calls. calls.
</para> </para>
</listitem> </listitem>
<listitem>
<para>
If you create the image with the <code>Location</code>
header and you have correct permissions, you can use API
calls to see the image status as <code>active</code>.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</wadl:doc> </wadl:doc>
<request> <request>
@ -253,7 +246,7 @@
</wadl:doc> </wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" name="name" style="plain" type="xsd:string"
required="true"> required="false">
<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" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">