From 84066c191ce97df1c4bd790b8b5cc72a6a7bdd42 Mon Sep 17 00:00:00 2001
From: Diane Fleming <diane.fleming@rackspace.com>
Date: Wed, 25 Sep 2013 13:43:17 -0500
Subject: [PATCH] Updated evacuate per bug and cleaned up other items in
 os-admin-actions.wadl

Partial-Bug: #1198771

Change-Id: I04b792c0055333dd85a70143bfaabcb43927874c
author: diane fleming
---
 api-ref/pom.xml                               |   2 +-
 api-ref/src/docbkx/api-ref-compute.xml        |  19 +-
 .../compute-api/src/ext/os-admin-actions.wadl | 237 +++++++++++++-----
 3 files changed, 171 insertions(+), 87 deletions(-)

diff --git a/api-ref/pom.xml b/api-ref/pom.xml
index 6af84c1c6..dd3d6ba13 100644
--- a/api-ref/pom.xml
+++ b/api-ref/pom.xml
@@ -13,7 +13,7 @@
   <name>OpenStack API Page Project</name>
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <doctools.version>1.9.3</doctools.version>
+    <doctools.version>1.11.0</doctools.version>
   </properties>
   <build>
     <plugins>
diff --git a/api-ref/src/docbkx/api-ref-compute.xml b/api-ref/src/docbkx/api-ref-compute.xml
index 17f0beb38..64bb0f5fe 100644
--- a/api-ref/src/docbkx/api-ref-compute.xml
+++ b/api-ref/src/docbkx/api-ref-compute.xml
@@ -16,23 +16,6 @@
             <para/>
         </legalnotice>
     </info>
-    <!--  <preface xml:id="compute_Overview">
-        <title>OpenStack Compute APIs and Extensions Reference</title>
-        <para>Use the following OpenStack APIs in your OpenStack
-            cloud. You must install the packages for each API
-            separately. After you authenticate through the <link
-                xlink:href="api-ref-identity.html">Identity Service
-                API</link>, you can use the other APIs and
-            extensions.</para>
-        <para>To get started with the APIs, see the <link
-                xlink:href="http://docs.openstack.org/api/quick-start/content/"
-                >OpenStack API Quick Start</link>. For detailed
-            information, see <link
-                xlink:href="http://docs.openstack.org/api/openstack-compute/2.0/content/"
-                    ><citetitle>OpenStack Compute API and Extensions
-                    Reference</citetitle></link>.</para>
-        <para>&nbsp;</para>
-    </preface> -->
     <chapter xml:id="compute">
         <title>Compute API v2</title>
         <para>Launches virtual machines from images or images stored
@@ -238,7 +221,7 @@
         <section xml:id="ext-os-admin-actions">
             <title>Server Admin Actions</title>
             <para>Permits administrators to perform actions on a
-                server.</para>
+                server. Specify the action in the request body.</para>
             <wadl:resources
                 href="../wadls/compute-api/src/ext/os-admin-actions.wadl"
                 xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
diff --git a/api-ref/src/wadls/compute-api/src/ext/os-admin-actions.wadl b/api-ref/src/wadls/compute-api/src/ext/os-admin-actions.wadl
index 3767bcb4e..e8255f622 100644
--- a/api-ref/src/wadls/compute-api/src/ext/os-admin-actions.wadl
+++ b/api-ref/src/wadls/compute-api/src/ext/os-admin-actions.wadl
@@ -49,7 +49,8 @@
         </resource>
     </resources>
     <method name="POST" id="pause">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Pause Server">
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Pause Server">
             <para role="shortdesc">Pauses a server. Changes its status
                 to PAUSED.</para>
         </wadl:doc>
@@ -82,13 +83,20 @@
         <response status="202"/>
     </method>
     <method name="POST" id="unpause">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Unpause Server">
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Unpause Server">
             <para role="shortdesc">Unpauses a PAUSED server and
-                changes its status to ACTIVE. Specify the
-                    <code>unpause</code> action in the request body.
-            </para>
+                changes its status to ACTIVE.</para>
         </wadl:doc>
         <request>
+            <param name="unpause" style="plain" type="xsd:string"
+                required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>unpause</code> action in
+                        the request body.</para>
+                </wadl:doc>
+            </param>
             <representation mediaType="application/json">
                 <wadl:doc xmlns="http://docbook.org/ns/docbook"
                     xml:lang="EN">
@@ -109,12 +117,20 @@
         <response status="202"/>
     </method>
     <method name="POST" id="suspend">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Suspend Server">
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Suspend Server">
             <para role="shortdesc">Suspends a server and changes its
-                status to SUSPENDED. Specify the <code>suspend</code>
-                action in the request body.</para>
+                status to SUSPENDED.</para>
         </wadl:doc>
         <request>
+            <param name="suspend" style="plain" type="xsd:string"
+                required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>suspend</code> action in
+                        the request body.</para>
+                </wadl:doc>
+            </param>
             <representation mediaType="application/json">
                 <wadl:doc xmlns="http://docbook.org/ns/docbook"
                     xml:lang="EN">
@@ -135,13 +151,20 @@
         <response status="202"/>
     </method>
     <method name="POST" id="resume">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Resume Server">
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Resume Server">
             <para role="shortdesc">Resumes a SUSPENDED server and
-                changes its status to ACTIVE. Specify the
-                    <code>resume</code> action in the request
-                body.</para>
+                changes its status to ACTIVE. </para>
         </wadl:doc>
         <request>
+            <param name="resume" style="plain" type="xsd:string"
+                required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>resume</code> action in
+                        the request body.</para>
+                </wadl:doc>
+            </param>
             <representation mediaType="application/json">
                 <doc xml:lang="EN">
                     <xsdxt:code
@@ -160,13 +183,20 @@
         <response status="202"/>
     </method>
     <method name="POST" id="migrate">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Migrate Server">
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Migrate Server">
             <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>
+                scheduler chooses the host.</para>
         </wadl:doc>
         <request>
+            <param name="migrate" style="plain" type="xsd:string"
+                required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>migrate</code> action in
+                        the request body.</para>
+                </wadl:doc>
+            </param>
             <representation mediaType="application/json">
                 <doc xml:lang="EN">
                     <xsdxt:code
@@ -178,12 +208,20 @@
         <response status="202"/>
     </method>
     <method name="POST" id="resetNetwork">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Reset Networking on Server">
-            <para role="shortdesc">Resets networking on a server.
-                Specify the <code>resetNetwork</code> action in the
-                request body.</para>
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Reset Networking on Server">
+            <para role="shortdesc">Resets networking on a
+                server.</para>
         </wadl:doc>
         <request>
+            <param name="resetNetwork" style="plain" type="xsd:string"
+                required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>resetNetwork</code> action
+                        in the request body.</para>
+                </wadl:doc>
+            </param>
             <representation mediaType="application/json">
                 <doc xml:lang="EN">
                     <xsdxt:code
@@ -202,12 +240,20 @@
         <response status="202"/>
     </method>
     <method name="POST" id="injectNetworkInfo">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Inject Network Information">
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Inject Network Information">
             <para role="shortdesc">Injects network information into a
-                server. Specify the <code>injectNetworkInfo</code>
-                action in the request body.</para>
+                server.</para>
         </wadl:doc>
         <request>
+            <param name="injectNetworkInfo" style="plain"
+                type="xsd:string" required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>injectNetworkInfo</code>
+                        action in the request body.</para>
+                </wadl:doc>
+            </param>
             <representation mediaType="application/json">
                 <doc xml:lang="EN">
                     <xsdxt:code
@@ -226,12 +272,19 @@
         <response status="202"/>
     </method>
     <method name="POST" id="lock">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Lock Server">
-            <para role="shortdesc">Locks a server. Specify the
-                    <code>lock</code> action in the request
-                body.</para>
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Lock Server">
+            <para role="shortdesc">Locks a server.</para>
         </wadl:doc>
         <request>
+            <param name="lock" style="plain" type="xsd:string"
+                required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>lock</code> action in the
+                        request body.</para>
+                </wadl:doc>
+            </param>
             <representation mediaType="application/json">
                 <doc xml:lang="EN">
                     <xsdxt:code
@@ -250,12 +303,19 @@
         <response status="202"/>
     </method>
     <method name="POST" id="unlock">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Unlock Server">
-            <para role="shortdesc">Unlocks a server. Specify the
-                    <code>unlock</code> action in the request
-                body.</para>
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Unlock Server">
+            <para role="shortdesc">Unlocks a server.</para>
         </wadl:doc>
         <request>
+            <param name="unlock" style="plain" type="xsd:string"
+                required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>unlock</code> action in
+                        the request body.</para>
+                </wadl:doc>
+            </param>
             <representation mediaType="application/json">
                 <doc xml:lang="EN">
                     <xsdxt:code
@@ -274,24 +334,31 @@
         <response status="202"/>
     </method>
     <method name="POST" id="createBackup">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Back up Server Instance">
-            <para role="shortdesc">Backs up a server instance. Specify
-                the <code>createBackup</code> action in the request
-                body.</para>
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Create Server Backup">
+            <para role="shortdesc">Backs up a server instance.</para>
         </wadl:doc>
         <request>
-            <param name="name" style="query" type="xsd:string"
+            <param name="createBackup" style="plain" type="xsd:string"
+                required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>createBackup</code> action
+                        in the request body.</para>
+                </wadl:doc>
+            </param>
+            <param name="name" style="plain" type="xsd:string"
                 required="true">
                 <doc><p xmlns="http://www.w3.org/1999/xhtml">Name of
                         the backup image.</p></doc>
             </param>
-            <param name="backup_type" style="query" required="true"
+            <param name="backup_type" style="plain" required="true"
                 type="xsd:string">
                 <doc><p xmlns="http://www.w3.org/1999/xhtml">The
                         backup type. Either 'daily' or
                     'weekly.'</p></doc>
             </param>
-            <param name="rotation" style="query" required="true"
+            <param name="rotation" style="plain" required="true"
                 type="xsd:int">
                 <doc><p xmlns="http://www.w3.org/1999/xhtml">An
                         integer value that represents the number of
@@ -315,24 +382,31 @@
         <response status="202"/>
     </method>
     <method name="POST" id="os-migrateLive">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Live-Migrate Server">
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Live-migrate Server">
             <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>
+                host without rebooting.</para>
         </wadl:doc>
         <request>
-            <param name="host" style="query" required="true"
+            <param name="os-migrateLive" style="plain"
+                type="xsd:string" required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>os-migrateLive</code>
+                        action in the request body.</para>
+                </wadl:doc>
+            </param>
+            <param name="host" style="plain" required="true"
                 type="xsd:string">
                 <doc><p xmlns="http://www.w3.org/1999/xhtml">Name of
                         the new host.</p></doc>
             </param>
-            <param name="block_migration" style="query"
+            <param name="block_migration" style="plain"
                 required="true" type="xsd:boolean">
                 <doc><p xmlns="http://www.w3.org/1999/xhtml">If true,
                         migration is blocked.</p></doc>
             </param>
-            <param name="disk_over_commit" style="query"
+            <param name="disk_over_commit" style="plain"
                 required="true" type="xsd:boolean">
                 <doc><p xmlns="http://www.w3.org/1999/xhtml">If true,
                         disk over commit is allowed.</p></doc>
@@ -357,14 +431,21 @@
         <response status="202"/>
     </method>
     <method name="POST" id="os-resetState">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Reset Server State">
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Reset Server State">
             <para role="shortdesc">Resets the state of a server to a
-                specified state. Specify the
-                    <code>os-resetState</code> action in the request
-                body.</para>
+                specified state.</para>
         </wadl:doc>
         <request>
-            <param name="state" style="query" required="true"
+            <param name="resetState" style="plain" type="xsd:string"
+                required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>resetState</code> action
+                        in the request body.</para>
+                </wadl:doc>
+            </param>
+            <param name="state" style="plain" required="true"
                 type="xsd:string">
                 <doc><p xmlns="http://www.w3.org/1999/xhtml">The
                         desired state of a server.</p></doc>
@@ -389,27 +470,37 @@
         <response status="202"/>
     </method>
     <method name="POST" id="evacuate">
-        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Evacuate Server">
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Evacuate Server">
             <para role="shortdesc">Evacuates a server from failed
-                host. Specify the <code>evacuate</code> action in the
-                request body.</para>
+                host.</para>
         </wadl:doc>
         <request>
-            <param name="host" style="query" required="true"
+            <param name="evacuate" style="plain" type="xsd:string"
+                required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <para>Specify the <code>evacuate</code> action in
+                        the request body.</para>
+                </wadl:doc>
+            </param>
+            <param name="host" style="plain" required="true"
                 type="xsd:string">
                 <doc><p xmlns="http://www.w3.org/1999/xhtml">The name
                         or ID of the host where the server is
                         evacuated.</p></doc>
             </param>
-            <param name="onSharedStorage" style="query"
-                type="xsd:string">
-                <doc><p xmlns="http://www.w3.org/1999/xhtml">Required
-                        if server is on shared storage.</p></doc>
+            <param name="adminPass" style="plain" type="xsd:string"
+                required="false">
+                <doc><p xmlns="http://www.w3.org/1999/xhtml">Specifies
+                        a new admin password for the evacuated
+                        instance.</p></doc>
             </param>
-            <param name="adminPass" style="query" type="xsd:string">
-                <doc><p xmlns="http://www.w3.org/1999/xhtml">Not
-                        specified with onSharedStorage. New admin
-                        password for the evacuated instance.</p></doc>
+            <param name="onSharedStorage" style="plain"
+                type="xsd:string" required="true">
+                <doc><p xmlns="http://www.w3.org/1999/xhtml">If server
+                        is on shared storage, set to True. Otherwise,
+                        set to False.</p></doc>
             </param>
             <representation mediaType="application/json">
                 <wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -446,11 +537,16 @@
     <method name="POST" id="addSecurityGroup">
         <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
             <para role="shortdesc">Assigns the specified security
-                group to the server. Specify the
-                    <code>addSecurityGroup</code> action in the
-                request body.</para>
+                group to the server.</para>
         </wadl:doc>
         <request>
+            <param name="addSecurityGroup" style="plain"
+                type="xsd:string" required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN"><para>Specify the
+                            <code>addSecurityGroup</code> action in
+                        the request body.</para></wadl:doc>
+            </param>
             <param name="name" style="plain" required="true"
                 type="xsd:string">
                 <doc><p xmlns="http://www.w3.org/1999/xhtml">The name
@@ -479,11 +575,16 @@
     <method name="POST" id="removeSecurityGroup">
         <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
             <para role="shortdesc">Removes the specified security
-                group from the server. Specify the
-                    <code>removeSecurityGroup</code> action in the
-                request body.</para>
+                group from the server.</para>
         </wadl:doc>
         <request>
+            <param name="removeSecurityGroup" style="plain"
+                type="xsd:string" required="true">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN"><para>Specify the
+                            <code>removeSecurityGroup</code> action in
+                        the request body.</para></wadl:doc>
+            </param>
             <param name="name" style="plain" required="true"
                 type="xsd:string">
                 <doc><p xmlns="http://www.w3.org/1999/xhtml">The name