Updated title to "API Reference" from "Dev Guide" for consistency

bug: #1178388

Change-Id: I03ac5c8a69e44fa0429b50711485f33c889c48b7
author: diane fleming
This commit is contained in:
Diane Fleming 2013-05-22 10:21:07 -05:00
parent 0473d6fa71
commit 95ccc46a2f
3 changed files with 13 additions and 130 deletions

View File

@ -77,11 +77,11 @@
<generateToc> appendix toc,title <generateToc> appendix toc,title
article/appendix nop article/appendix nop
article toc,title article toc,title
book title,figure,table,example,equation book toc,title,figure,table,example,equation
chapter toc,title chapter toc
section toc section toc
part toc,title part toc,title
preface toc,title preface toc
qandadiv toc qandadiv toc
qandaset toc qandaset toc
reference toc,title reference toc,title

View File

@ -34,10 +34,10 @@
xmlns:html="http://www.w3.org/1999/xhtml" xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:db="http://docbook.org/ns/docbook" version="5.0" xmlns:db="http://docbook.org/ns/docbook" version="5.0"
xml:id="os-cs-devguide"> xml:id="os-cs-devguide">
<title>OpenStack Compute API and Extensions Specification</title> <title>OpenStack Compute API v2 and Extensions Reference</title>
<?rax title.font.size="28px" subtitle.font.size="28px"?> <?rax title.font.size="26px" subtitle.font.size="26px"?>
<titleabbrev>OpenStack Compute API and Extensions <titleabbrev>Compute API and Extensions
Specification</titleabbrev> Reference</titleabbrev>
<info> <info>
<author> <author>
<personname> <personname>
@ -57,7 +57,7 @@
<holder>OpenStack Foundation</holder> <holder>OpenStack Foundation</holder>
</copyright> </copyright>
<releaseinfo>API v2</releaseinfo> <releaseinfo>API v2</releaseinfo>
<productname>OpenStack Compute API and Extensions</productname> <productname>OpenStack Compute API v2 and Extensions</productname>
<pubdate/> <pubdate/>
<legalnotice role="apache2"> <legalnotice role="apache2">
<annotation> <annotation>
@ -74,7 +74,7 @@
<revhistory> <revhistory>
<revision> <revision>
<!-- ... continue addding more revisions here as you change this document using the markup shown below... --> <!-- ... continue addding more revisions here as you change this document using the markup shown below... -->
<date>2013-05-09</date> <date>2013-05-22</date>
<revdescription> <revdescription>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -1201,8 +1201,8 @@ Host: servers.api.openstack.org/v2/
machine-processable description is written in the Web machine-processable description is written in the Web
Application Description Language (WADL). </para> Application Description Language (WADL). </para>
<note> <note>
<para>If there is a discrepancy between the two <para>If a discrepancy exists between the two
specifications, the WADL is authoritative as it References, the WADL is authoritative as it
contains the most accurate and up-to-date contains the most accurate and up-to-date
description of the API service. </para> description of the API service. </para>
</note> </note>
@ -3022,7 +3022,7 @@ Host: servers.api.openstack.org/v2/
<para>The resize operation converts an existing server <para>The resize operation converts an existing server
to a different flavor, in essence, scaling the to a different flavor, in essence, scaling the
server up or down. The original server is saved server up or down. The original server is saved
<<<<<<< HEAD
for a period of time to allow rollback if a problem occurs. for a period of time to allow rollback if a problem occurs.
You should test and explicitly confirm all resizes. When you confirm a resize, You should test and explicitly confirm all resizes. When you confirm a resize,
the original server is removed. the original server is removed.
@ -3030,24 +3030,7 @@ All resizes are automatically
confirmed after 24 hours if you do not confirmed after 24 hours if you do not
explicitly confirm or revert them. </para> explicitly confirm or revert them. </para>
<para>Depending on the cloud provider, this operation might result in billing you for a snapshot. </para> <para>Depending on the cloud provider, this operation might result in billing you for a snapshot. </para>
=======
for a period of time to allow rollback if
a problem occurs. You should test and explicitly confirm all resizes. When you confirm a resize, the original
server is removed. All resizes are automatically
confirmed after 24 hours if you do not explicitly confirm or resize them.
</para>
<para>You can complete the following types of migrations:
<itemizedlist><listitem><para>Live migrate with block storage migration. In the request body, set
the block_migration parameter to true.
</para></listitem><listitem><para>Live migrate without block storage migration.
In the request body, set
the block_migration parameter to false.</para></listitem>
<listitem><para>Non-live migrate</para></listitem>
<listitem><para>Resize (this operation)</para></listitem>
</itemizedlist></para>
<para>Depending on your cloud provider, this operation might result in billing you for a snapshot.
You can delete the snapshot after you complete this operation.</para>
>>>>>>> a59ebf6... Added information about migration types and billing
<para>Specify the server ID as <para>Specify the server ID as
<parameter>id</parameter> in the URI. </para> <parameter>id</parameter> in the URI. </para>
<para>In the request body, specify the <para>In the request body, specify the

View File

@ -58,24 +58,14 @@
element="compext:action"> element="compext:action">
<doc xml:lang="EN"> <doc xml:lang="EN">
<xsdxt:code <xsdxt:code
<<<<<<< HEAD
href="../samples/admin-actions-pause.json"/> href="../samples/admin-actions-pause.json"/>
=======
href="../samples/admin-actions-pause.json"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
<representation mediaType="application/xml" <representation mediaType="application/xml"
element="compext:action"> element="compext:action">
<doc xml:lang="EN"> <doc xml:lang="EN">
<xsdxt:code <xsdxt:code
<<<<<<< HEAD
href="../samples/admin-actions-pause.xml"/> href="../samples/admin-actions-pause.xml"/>
=======
href="../samples/admin-actions-pause.xml"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
</request> </request>
@ -93,24 +83,14 @@
element="compext:action"> element="compext:action">
<doc xml:lang="EN"> <doc xml:lang="EN">
<xsdxt:code <xsdxt:code
<<<<<<< HEAD
href="../samples/admin-actions-unpause.json"/> href="../samples/admin-actions-unpause.json"/>
=======
href="../samples/admin-actions-unpause.json"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
<representation mediaType="application/xml" <representation mediaType="application/xml"
element="compext:action"> element="compext:action">
<doc xml:lang="EN"> <doc xml:lang="EN">
<xsdxt:code <xsdxt:code
<<<<<<< HEAD
href="../samples/admin-actions-unpause.xml"/> href="../samples/admin-actions-unpause.xml"/>
=======
href="../samples/admin-actions-unpause.xml"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
</request> </request>
@ -128,24 +108,14 @@
element="compext:action"> element="compext:action">
<doc xml:lang="EN"> <doc xml:lang="EN">
<xsdxt:code <xsdxt:code
<<<<<<< HEAD
href="../samples/admin-actions-suspend.json"/> href="../samples/admin-actions-suspend.json"/>
=======
href="../samples/admin-actions-suspend.json"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
<representation mediaType="application/xml" <representation mediaType="application/xml"
element="compext:action"> element="compext:action">
<doc xml:lang="EN"> <doc xml:lang="EN">
<xsdxt:code <xsdxt:code
<<<<<<< HEAD
href="../samples/admin-actions-suspend.xml"/> href="../samples/admin-actions-suspend.xml"/>
=======
href="../samples/admin-actions-suspend.xml"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
</request> </request>
@ -163,24 +133,14 @@
element="compext:action"> element="compext:action">
<doc xml:lang="EN"> <doc xml:lang="EN">
<xsdxt:code <xsdxt:code
<<<<<<< HEAD
href="../samples/admin-actions-resume.json"/> href="../samples/admin-actions-resume.json"/>
=======
href="../samples/admin-actions-resume.json"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
<representation mediaType="application/xml" <representation mediaType="application/xml"
element="compext:action"> element="compext:action">
<doc xml:lang="EN"> <doc xml:lang="EN">
<xsdxt:code <xsdxt:code
<<<<<<< HEAD
href="../samples/admin-actions-resume.xml"/> href="../samples/admin-actions-resume.xml"/>
=======
href="../samples/admin-actions-resume.xml"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
</request> </request>
@ -189,18 +149,6 @@
<method name="POST" id="migrate"> <method name="POST" id="migrate">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Migrate Server"> title="Migrate Server">
<<<<<<< HEAD
<para role="shortdesc">Migrates a server to a host. The
scheduler chooses the host. Specify the
<code>migrate</code> action in the request body. </para>
<para>You can complete the following types of migrations:
live migrate with block storage migration; live
migrate without block storage migration; non-live
migrate (this operation), or; resize. Depending on the
cloud provider, these operations might result in billing you for a
snapshot. You can delete the snapshot after you
complete the migrate operation.</para>
=======
<para role="shortdesc">Migrates a server to a host. The scheduler chooses <para role="shortdesc">Migrates a server to a host. The scheduler chooses
the host. Specify the <code>migrate</code> action in the host. Specify the <code>migrate</code> action in
the request body. </para> the request body. </para>
@ -212,19 +160,13 @@
</itemizedlist></para> </itemizedlist></para>
<para>Depending on your cloud provider, this operation might result in billing you for a snapshot. <para>Depending on your cloud provider, this operation might result in billing you for a snapshot.
You can delete the snapshot after you complete this operation.</para> You can delete the snapshot after you complete this operation.</para>
>>>>>>> a59ebf6... Added information about migration types and billing
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/xml" <representation mediaType="application/xml"
element="compext:action"> element="compext:action">
<doc xml:lang="EN"> <doc xml:lang="EN">
<xsdxt:code <xsdxt:code
<<<<<<< HEAD
href="../samples/admin-actions-migrate.json"/> href="../samples/admin-actions-migrate.json"/>
=======
href="../samples/admin-actions-migrate.json"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
</request> </request>
@ -380,20 +322,6 @@
<method name="POST" id="os-migrateLive"> <method name="POST" id="os-migrateLive">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Live-Migrate Server"> title="Live-Migrate Server">
<<<<<<< HEAD
<para role="shortdesc">Live-migrates a server to a new
host without rebooting. Specify the
<code>os-migrateLive</code> action in the request
body. </para>
<para>You can complete the following types of migrations:
live migrate with block storage migration (this
operation); live migrate without block storage
migration (this operation); non-live migrate (this
operation), or; resize. Depending on the
cloud provider, these operations might result in billing you for a
snapshot. You can delete the snapshot after you
complete the migrate operation.</para>
=======
<para role="shortdesc">Live-migrates a server to a new host without <para role="shortdesc">Live-migrates a server to a new host without
rebooting. Specify the <code>os-migrateLive</code> rebooting. Specify the <code>os-migrateLive</code>
action in the request body. </para> action in the request body. </para>
@ -405,7 +333,6 @@
</itemizedlist></para> </itemizedlist></para>
<para>Depending on your cloud provider, this operation might result in billing you for a snapshot. <para>Depending on your cloud provider, this operation might result in billing you for a snapshot.
You can delete the snapshot after you complete this operation.</para> You can delete the snapshot after you complete this operation.</para>
>>>>>>> a59ebf6... Added information about migration types and billing
</wadl:doc> </wadl:doc>
<request> <request>
<param name="host" style="query" required="true" <param name="host" style="query" required="true"
@ -414,13 +341,8 @@
</param> </param>
<param name="block_migration" style="query" <param name="block_migration" style="query"
required="true" type="xsd:boolean"> required="true" type="xsd:boolean">
<<<<<<< HEAD
<doc>If true, block storage is migrated. If false, <doc>If true, block storage is migrated. If false,
block storage is not migrated.</doc> block storage is not migrated.</doc>
=======
<doc>If true, block storage is migrated.
If false, block storage is not migrated.</doc>
>>>>>>> a59ebf6... Added information about migration types and billing
</param> </param>
<param name="disk_over_commit" style="query" <param name="disk_over_commit" style="query"
required="true" type="xsd:boolean"> required="true" type="xsd:boolean">
@ -478,18 +400,11 @@
<response status="202"/> <response status="202"/>
</method> </method>
<method name="POST" id="evacuate"> <method name="POST" id="evacuate">
<<<<<<< HEAD
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Evacuate Server"> title="Evacuate Server">
<para>Evacuates a server from failed host. Specify the <para>Evacuates a server from failed host. Specify the
<code>evacuate</code> action in the request <code>evacuate</code> action in the request
body.</para> body.</para>
=======
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">Evacuates a server
from failed host. Specify the <code>evacuate</code>
action in the request body.</p>
>>>>>>> a59ebf6... Added information about migration types and billing
</wadl:doc> </wadl:doc>
<request> <request>
<param name="host" style="query" required="true" <param name="host" style="query" required="true"
@ -514,24 +429,14 @@
</param> </param>
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <doc xml:lang="EN">
<<<<<<< HEAD
<xsdxt:code <xsdxt:code
href="../samples/server-evacuate-req.json"/> href="../samples/server-evacuate-req.json"/>
=======
<xsdxt:code href="../samples/server-evacuate-req.json"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <doc xml:lang="EN">
<<<<<<< HEAD
<xsdxt:code <xsdxt:code
href="../samples/server-evacuate-req.xml"/> href="../samples/server-evacuate-req.xml"/>
=======
<xsdxt:code href="../samples/server-evacuate-req.xml"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
</request> </request>
@ -544,13 +449,8 @@
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <doc xml:lang="EN">
<<<<<<< HEAD
<xsdxt:code <xsdxt:code
href="../samples/server-evacuate-resp.xml"/> href="../samples/server-evacuate-resp.xml"/>
=======
<xsdxt:code href="../samples/server-evacuate-resp.xml"
/>
>>>>>>> a59ebf6... Added information about migration types and billing
</doc> </doc>
</representation> </representation>
</response> </response>