openstack/api-site
Code Issues Proposed changes

Merge "Add doc support to os-server-password extension"

Browse Source
This commit is contained in:
Jenkins 2013-03-06 14:19:10 +00:00 committed by Gerrit Code Review
commit 8a1ccf22ec
2 changed files with 87 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api-ref/src/docbkx/api-ref.xml
View File

@ -96,6 +96,14 @@
href="../wadls/compute-api/src/ext/os-consoles.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-server-password">
<title>Server Password</title>
<para>This extension retrieves and resets the encrypted
admin password set through metadata service.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-server-password.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-server-start-stop">
<title>Server Start/Stop</title>
<para>Starts and stops a server.</para>

79
api-ref/src/wadls/compute-api/src/ext/os-server-password.wadl Normal file
View File

@ -0,0 +1,79 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack LLC., All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://servers.api.openstack.com">
<resource id="version" type="#VersionDetails" path="v2/">
<resource id="Servers" path="servers">
<resource path="{server_id}">
<param name="server_id" style="template" type="csapi:UUID">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The UUID for the server of interest to you.
</p>
</doc>
</param>
<resource id="os-server-password" path="os-server-password">
<method href="#getPassword" />
<method href="#resetPassword" />
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="getPassword">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Retrieve the admin password for the specified server.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-server-password/get-password-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-server-password/get-password-resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="POST" id="resetPassword">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Reset the admin password for the specified server.
</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-server-password/server-post-req.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-server-password/server-post-req.xml" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-server-password/server-post-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="../api_samples/os-server-password/server-post-resp.xml" />
</doc>
</representation>
</response>
</method>
</application>