openstack/api-site
Code Issues Proposed changes

Merge "Add parameter list to "Evacuate server" API (v2.1)"

Browse Source
This commit is contained in:
Jenkins 2015-07-25 18:03:54 +00:00 committed by Gerrit Code Review
commit 9eb44d6184
1 changed files with 44 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-evacuate-v2.1.wadl
View File

@ -23,8 +23,9 @@
<method name="POST" id="evacuateserver">
<wadl:doc xml:lang="EN" title="Evacuate server"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Evacuates a server from a failed
host to a new one.</para>
<para role="shortdesc">
Evacuates a server from a failed host to a new one.
</para>
<para>
Specify the <code>evacuate</code> action in the request body.
</para>
@ -36,6 +37,47 @@
href="../api_samples/os-evacuate/server-evacuate-req.json"
/>
</wadl:doc>
<param name="evacuate" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Evacuate action">
<para>
Specify the <code>evacuate</code> action in the
request body.
</para>
</wadl:doc>
</param>
<param name="host" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Host">
<para>
The name or ID of the host to which the server
is evacuated.
</para>
</wadl:doc>
</param>
<param name="adminPass" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Admin password">
<para>
An administrative password to access the
evacuated instance.
</para>
</wadl:doc>
</param>
<param name="onSharedStorage" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="On shared storage flag">
<para>
Set to <code>True</code> to indicate that server
is on shared storage. Otherwise, set to
<code>False</code>.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">