From da0bfac1e5b37266760ed0476d28ff642b4b6800 Mon Sep 17 00:00:00 2001
From: jakedahn <jake@ansolabs.com>
Date: Tue, 3 Apr 2012 15:40:07 -0700
Subject: [PATCH] Adding consoles server action to docs

Change-Id: Ib8bbaa22d985591d089f13968b36fc5940b99ec2
---
 .../openstack-api-site/src/docbkx/index.xml   |  7 +++
 .../compute-api/src/ext/os-consoles.wadl      | 61 +++++++++++++++++++
 .../src/ext/samples/consoles-request.json     |  5 ++
 .../src/ext/samples/consoles-response.json    |  6 ++
 4 files changed, 79 insertions(+)
 create mode 100644 doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-consoles.wadl
 create mode 100644 doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/consoles-request.json
 create mode 100644 doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/consoles-response.json

diff --git a/doc/src/docbkx/openstack-api-site/src/docbkx/index.xml b/doc/src/docbkx/openstack-api-site/src/docbkx/index.xml
index 51c959430f..f5ec22e070 100644
--- a/doc/src/docbkx/openstack-api-site/src/docbkx/index.xml
+++ b/doc/src/docbkx/openstack-api-site/src/docbkx/index.xml
@@ -125,6 +125,13 @@
         href="ext/os-keypairs.wadl" 
         xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
     </section>
+    <section xml:id="ext-os-consoles">
+      <title>Consoles</title>
+      <para>Gain access to a VNC console for a specific server.</para>
+      <wadl:resources 
+        href="ext/os-consoles.wadl" 
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+    </section>
   </chapter>
   <chapter xml:id="image">
     <title>Image</title>
diff --git a/doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-consoles.wadl b/doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-consoles.wadl
new file mode 100644
index 0000000000..cb5793f94d
--- /dev/null
+++ b/doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-consoles.wadl
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- (C) 2012 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="v1.1/">
+            <resource id="tenantID" path="{tenant_id}">
+                <param name="tenant_id" style="template" type="xsd:string">
+                    <doc><p xmlns="http://www.w3.org/1999/xhtml">
+                      The ID for the tenant or account in a multi-tenancy cloud.
+                    </p></doc>
+                </param>
+
+             <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 path="action">
+                        <method href="#getConsole"/>
+                    </resource>
+                </resource>
+             </resource>
+           </resource>
+       </resource>
+    </resources>
+
+    <method name="POST" id="getConsole">
+        <wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
+            <p xmlns="http://www.w3.org/1999/xhtml">Fetch a console.</p>
+        </wadl:doc>
+        <request>
+            <param name="type" style="plain" required="true">
+              <doc><p xmlns="http://www.w3.org/1999/xhtml">
+                Acceptable values are 'novnc' and 'xvpvnc'.
+              </p></doc>
+            </param>
+            <representation mediaType="application/json">
+                <doc xml:lang="EN">
+                    <xsdxt:code href="samples/consoles-request.json" />
+                </doc>
+            </representation>
+        </request>
+        <response status="200">
+            <representation mediaType="application/json">
+                <doc xml:lang="EN">
+                    <xsdxt:code href="samples/consoles-response.json" />
+                </doc>
+            </representation>
+        </response>
+    </method>
+
+</application>
diff --git a/doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/consoles-request.json b/doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/consoles-request.json
new file mode 100644
index 0000000000..1f031c3921
--- /dev/null
+++ b/doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/consoles-request.json
@@ -0,0 +1,5 @@
+{
+    "os-getVNCConsole": {
+        "type": "novnc"
+    }
+}
\ No newline at end of file
diff --git a/doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/consoles-response.json b/doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/consoles-response.json
new file mode 100644
index 0000000000..43a7e5a9d4
--- /dev/null
+++ b/doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/consoles-response.json
@@ -0,0 +1,6 @@
+{
+    "console": {
+        "type": "novnc",
+        "url": "http://example.com:6080/vnc_auto.html?token=f9906a48-b71e-4f18-baca-c987da3ebdb3&title=dafa(75ecef58-3b8e-4659-ab3b-5501454188e9)"
+    }
+}