openstack/api-site
Code Issues Proposed changes

Fix Image service capitalization

Browse Source 
Update capitalization for Image service, also fix a few occurences
of other wrong capitalization.

Change-Id: I9b5cec7726c1d6c10231ffa5eefe7a7093b631eb
This commit is contained in:
Andreas Jaeger 2015-04-14 16:17:58 +02:00
parent 19a11c6035
commit 32f349b0a1
10 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-quick-start/src/docbkx/api-quick-start-onepager.xml
View File

@ -9,7 +9,7 @@
<?dbhtml stop-chunking?> <?dbhtml stop-chunking?>
<para>Although you install each OpenStack service separately, the <para>Although you install each OpenStack service separately, the
OpenStack services work together to meet your cloud needs: OpenStack services work together to meet your cloud needs:
Identity, Compute, Image Service, Block Storage, Networking Identity, Compute, Image service, Block Storage, Networking
(neutron), Object Storage, Orchestration, and Telemetry. With (neutron), Object Storage, Orchestration, and Telemetry. With
the <link xlink:href="http://www.trystack.org/" the <link xlink:href="http://www.trystack.org/"
>TryStack</link> OpenStack installation, these services >TryStack</link> OpenStack installation, these services

2
api-ref/src/docbkx/api-ref-image-v2.xml
View File

@ -8,7 +8,7 @@
version="5.0-extension RackBook-2.0" version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-image-v2" status="CURRENT"> xml:id="api.openstack.org-image-v2" status="CURRENT">
<info xreflabel="api-ref-image-v2.html"> <info xreflabel="api-ref-image-v2.html">
<title>OpenStack Image Service API v2 (CURRENT)</title> <title>OpenStack Image service API v2 (CURRENT)</title>
<copyright> <copyright>
<year>2010-2015</year> <year>2010-2015</year>
</copyright> </copyright>

2
api-ref/src/docbkx/ch_images-v1.xml
View File

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="images-api-v1" version="5.0-extension RackBook-2.0" xml:id="images-api-v1"
role="api-reference"> role="api-reference">
<title>Image Service API v1 (SUPPORTED)</title> <title>Image service API v1 (SUPPORTED)</title>
<para>Load images for use at launch time by the Compute API. Also, <para>Load images for use at launch time by the Compute API. Also,
assign metadata to images.</para> assign metadata to images.</para>
<para>Some cloud implementations do not expose this API and offer <para>Some cloud implementations do not expose this API and offer

4
api-ref/src/docbkx/ch_images-v2.xml
View File

@ -7,8 +7,8 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="images-api-v2" version="5.0-extension RackBook-2.0" xml:id="images-api-v2"
role="api-reference"> role="api-reference">
<title>Image Service API v2 (CURRENT)</title> <title>Image service API v2 (CURRENT)</title>
<para>Image Service API v2.0, API v2.1, and API v2.2.</para> <para>Image service API v2.0, API v2.1, and API v2.2.</para>
<para>Cloud providers can configure property protections that <para>Cloud providers can configure property protections that
prevent non-administrative users from updating and deleting prevent non-administrative users from updating and deleting
protected properties. For more information, see <link protected properties. For more information, see <link

4
api-ref/src/docbkx/itemizedlist-service-list.xml
View File

@ -69,11 +69,11 @@
v2.0 extensions (SUPPORTED)</link></para> v2.0 extensions (SUPPORTED)</link></para>
</listitem> </listitem>
<listitem> <listitem>
<para><link xlink:type="simple" xlink:href="api-ref-image-v2.html">Image Service <para><link xlink:type="simple" xlink:href="api-ref-image-v2.html">Image service
API v2 (CURRENT)</link></para> API v2 (CURRENT)</link></para>
</listitem> </listitem>
<listitem> <listitem>
<para><link xlink:type="simple" xlink:href="api-ref-image-v1.html">Image Service <para><link xlink:type="simple" xlink:href="api-ref-image-v1.html">Image service
API v1 (SUPPORTED)</link></para> API v1 (SUPPORTED)</link></para>
</listitem> </listitem>
<listitem> <listitem>

10
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-actions.wadl
View File

@ -221,7 +221,7 @@
succeeded. A successfully creating image operation shows an succeeded. A successfully creating image operation shows an
image's status of <code>available</code> and the serve's image's status of <code>available</code> and the serve's
status goes back to the original status. You can also see the status goes back to the original status. You can also see the
new image in the image backend that OpenStack Image Service new image in the image backend that OpenStack Image service
manages. manages.
</para> </para>
<para>Preconditions</para> <para>Preconditions</para>
@ -230,7 +230,7 @@
<listitem><para>You can only create a new image from the server <listitem><para>You can only create a new image from the server
when its status is <code>ACTIVE</code>, <code>SHUTOFF</code>, when its status is <code>ACTIVE</code>, <code>SHUTOFF</code>,
<code>PAUSED</code>, or <code>SUSPENDED</code>.</para></listitem> <code>PAUSED</code>, or <code>SUSPENDED</code>.</para></listitem>
<listitem><para>The connection to the Image Service is valid. <listitem><para>The connection to the Image service is valid.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
<para>Troubleshooting</para> <para>Troubleshooting</para>
@ -247,10 +247,10 @@
again, investigate the compute backend or ask your cloud provider. again, investigate the compute backend or ask your cloud provider.
</para></listitem> </para></listitem>
<listitem><para>If the request fails due to an error on OpenStack <listitem><para>If the request fails due to an error on OpenStack
Compute Service, the image is purged from the image store that Compute service, the image is purged from the image store that
OpenStack Image Service manages. Ensure you meet the preconditions OpenStack Image service manages. Ensure you meet the preconditions
and run the request again. If the request fails again, investigate and run the request again. If the request fails again, investigate
OpenStack Compute Service or ask your cloud provider. OpenStack Compute service or ask your cloud provider.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
</wadl:doc> </wadl:doc>

12
api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl
View File

@ -365,7 +365,7 @@
<itemizedlist> <itemizedlist>
<listitem><para>The user must have enough server quota remaining <listitem><para>The user must have enough server quota remaining
to create the number of servers requested.</para></listitem> to create the number of servers requested.</para></listitem>
<listitem><para>The connection to the Image Service is <listitem><para>The connection to the Image service is
valid.</para></listitem> valid.</para></listitem>
</itemizedlist> </itemizedlist>
<para>Asynchronous Postconditions</para> <para>Asynchronous Postconditions</para>
@ -987,14 +987,14 @@
shows an image's status of <code>available</code> and the shows an image's status of <code>available</code> and the
serve's status goes back to the original status. You can serve's status goes back to the original status. You can
also see the new image in the image backend that OpenStack also see the new image in the image backend that OpenStack
Image Service manages.</para> Image service manages.</para>
<para>Preconditions</para> <para>Preconditions</para>
<itemizedlist> <itemizedlist>
<listitem><para>The specified server must exist.</para></listitem> <listitem><para>The specified server must exist.</para></listitem>
<listitem><para>You can only create a new image from the server <listitem><para>You can only create a new image from the server
when its status is <code>ACTIVE</code>, <code>SHUTOFF</code>, when its status is <code>ACTIVE</code>, <code>SHUTOFF</code>,
<code>PAUSED</code>, or <code>SUSPENDED</code>.</para></listitem> <code>PAUSED</code>, or <code>SUSPENDED</code>.</para></listitem>
<listitem><para>The connection to the Image Service is valid. <listitem><para>The connection to the Image service is valid.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
<para>Troubleshooting</para> <para>Troubleshooting</para>
@ -1010,10 +1010,10 @@
again, investigate the compute backend or ask your cloud provider. again, investigate the compute backend or ask your cloud provider.
</para></listitem> </para></listitem>
<listitem><para>If the request fails due to an error on OpenStack <listitem><para>If the request fails due to an error on OpenStack
Compute Service, the image is purged from the image store that Compute service, the image is purged from the image store that
OpenStack Image Service manages. Ensure you meet the preconditions OpenStack Image service manages. Ensure you meet the preconditions
and run the request again. If the request fails again, investigate and run the request again. If the request fails again, investigate
OpenStack Compute Service or ask your cloud provider.</para></listitem> OpenStack Compute service or ask your cloud provider.</para></listitem>
</itemizedlist> </itemizedlist>
</wadl:doc> </wadl:doc>
<request> <request>

4
api-ref/src/wadls/image-api/src/v1/os-image-1.0.wadl
View File

@ -132,7 +132,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="List API versions"><para xml:lang="EN" title="List API versions"><para
role="shortdesc">Lists information about all Image role="shortdesc">Lists information about all Image
Service API versions.</para> service API versions.</para>
</wadl:doc> </wadl:doc>
<response status="200 300"> <response status="200 300">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -150,7 +150,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"
title="Show API v1 details"> title="Show API v1 details">
<para role="shortdesc">Shows details for Image Service API <para role="shortdesc">Shows details for Image service API
v1.</para> v1.</para>
</wadl:doc> </wadl:doc>
<response status="200 203"> <response status="200 203">

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

@ -258,7 +258,7 @@
style="plain" required="true" type="xsd:string"> style="plain" required="true" type="xsd:string">
<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>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.</para> verification.</para>
<para>If this field has no value, its <para>If this field has no value, its
value is <code>None</code>.</para> value is <code>None</code>.</para>

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

@ -82,7 +82,7 @@
<wadl:doc xml:lang="EN" title="List API versions" <wadl:doc xml:lang="EN" title="List API versions"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists information about all Image <para role="shortdesc">Lists information about all Image
Service API versions.</para> service API versions.</para>
</wadl:doc> </wadl:doc>
<response status="200 300"> <response status="200 300">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -202,7 +202,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Name for the image. The xml:lang="EN"><para>Name for the image. The
name of an image is not unique to a Image name of an image is not unique to a Image
Service node. The API cannot expect users service node. The API cannot expect users
to know the names of images owned by to know the names of images owned by
others.</para></wadl:doc> others.</para></wadl:doc>
</param> </param>
@ -414,7 +414,7 @@
<listitem><para>The image is deleted in images index. <listitem><para>The image is deleted in images index.
</para></listitem> </para></listitem>
<listitem><para>The binary image data managed by OpenStack <listitem><para>The binary image data managed by OpenStack
Image Service is deleted from the storage node if the Image service is deleted from the storage node if the
deleted image stores image data in the node.</para></listitem> deleted image stores image data in the node.</para></listitem>
</itemizedlist> </itemizedlist>
<para>TroubleShooting</para> <para>TroubleShooting</para>
@ -459,7 +459,7 @@
<listitem><para>The user must have enough image strage quota <listitem><para>The user must have enough image strage quota
remaining to store the data.</para></listitem> remaining to store the data.</para></listitem>
<listitem><para>Size of the data must be less than OpenStack <listitem><para>Size of the data must be less than OpenStack
Image Service restricts.</para></listitem> Image service restricts.</para></listitem>
</itemizedlist> </itemizedlist>
<para>Synchronous Postconditions</para> <para>Synchronous Postconditions</para>
<itemizedlist> <itemizedlist>
@ -467,7 +467,7 @@
image status as <code>active</code> through API calls. image status as <code>active</code> through API calls.
</para></listitem> </para></listitem>
<listitem><para>With correct access, you can see the stored <listitem><para>With correct access, you can see the stored
data in the storage system that OpenStack Image Service data in the storage system that OpenStack Image service
manages.</para></listitem> manages.</para></listitem>
</itemizedlist> </itemizedlist>
<para>Troubleshooting</para> <para>Troubleshooting</para>