summaryrefslogtreecommitdiffstats
path: root/docs/guide
diff options
context:
space:
mode:
authorJorge L. Williams <jorge.williams@rackspace.com>2011-04-15 01:35:18 -0500
committerJorge L. Williams <jorge.williams@rackspace.com>2011-04-15 01:35:18 -0500
commit82c86e9af9578f2b507de5abaeb5b16690e9ffb7 (patch)
tree7a61df56231fcd1b810dda1333f4aa766e1c1b71 /docs/guide
parent0a7d594d4e9bc59450e79a7463cb8e41e8e4773d (diff)
Initial WADL with token operations.
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/src/docbkx/idm.wadl135
1 files changed, 135 insertions, 0 deletions
diff --git a/docs/guide/src/docbkx/idm.wadl b/docs/guide/src/docbkx/idm.wadl
new file mode 100644
index 00000000..ec4b8a09
--- /dev/null
+++ b/docs/guide/src/docbkx/idm.wadl
@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<application xmlns="http://wadl.dev.java.net/2009/02"
+ xmlns:idm="http://docs.openstack.org/idm/api/v1.0"
+ xmlns:capi="http://docs.openstack.org/common/api/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+ xsi:schemaLocation="http://docs.openstack.org/idm/api/v1.0
+ xsd/api.xsd
+ http://docs.openstack.org/common/api/v1.0
+ xsd/api-common.xsd
+ ">
+ <grammars>
+ <include href="xsd/api.xsd"/>
+ <include href="xsd/api-common.xsd"/>
+ </grammars>
+
+ <resources base="https://idm.api.openstack.org">
+ <resource id="version" path="v1.0">
+ <method href="#getVersionInfo"/>
+ <resource id="token" path="token">
+ <method href="#authenticate" />
+ <resource id="tokenId" path="{tokenId}">
+ <param name="tokenId" style="template" type="xsd:string"/>
+ <method href="#validateToken"/>
+ <method href="#revokeToken"/>
+ </resource>
+ </resource>
+ </resource>
+ </resources>
+
+ <method name="GET" id="getVersionInfo">
+ <response status="200 203">
+ <representation mediaType="application/xml" element="capi:version"/>
+ <representation mediaType="application/json"/>
+ </response>
+ <response status="500">
+ <representation mediaType="application/xml" element="idm:idmFault"/>
+ </response>
+ <response status="503">
+ <representation mediaType="application/xml" element="idm:serviceUnavailable"/>
+ </response>
+ <response status="500 503">
+ <representation mediaType="application/json"/>
+ </response>
+ </method>
+
+ <method name="POST" id="authenticate">
+ <request>
+ <representation mediaType="application/xml" element="idm:passwordCredentials"/>
+ <representation mediaType="application/json"/>
+ </request>
+ <response status="200 203">
+ <representation mediaType="application/xml" element="idm:auth"/>
+ <representation mediaType="application/json"/>
+ </response>
+ <response status="401">
+ <representation mediaType="application/xml" element="idm:unauthorized"/>
+ </response>
+ <response status="403">
+ <representation mediaType="application/xml" element="idm:userDisabled"/>
+ </response>
+ <response status="400">
+ <representation mediaType="application/xml" element="idm:badRequest"/>
+ </response>
+ <response status="500">
+ <representation mediaType="application/xml" element="idm:idmFault"/>
+ </response>
+ <response status="503">
+ <representation mediaType="application/xml" element="idm:serviceUnavailable"/>
+ </response>
+ <response status="401 403 400 500 503">
+ <representation mediaType="application/json"/>
+ </response>
+ </method>
+
+ <method name="GET" id="validateToken">
+ <request>
+ <param name="belongsTo" style="query"
+ required="false" type="xsd:string"/>
+ </request>
+ <response status="200 203">
+ <representation mediaType="application/xml" element="idm:auth"/>
+ <representation mediaType="application/json"/>
+ </response>
+ <response status="401">
+ <representation mediaType="application/xml" element="idm:unauthorized"/>
+ </response>
+ <response status="403">
+ <representation mediaType="application/xml" element="idm:forbidden"/>
+ <representation mediaType="application/xml" element="idm:userDisabled"/>
+ </response>
+ <response status="400">
+ <representation mediaType="application/xml" element="idm:badRequest"/>
+ </response>
+ <response status="404">
+ <representation mediaType="application/xml" element="idm:itemNotFound"/>
+ </response>
+ <response status="500">
+ <representation mediaType="application/xml" element="idm:idmFault"/>
+ </response>
+ <response status="503">
+ <representation mediaType="application/xml" element="idm:serviceUnavailable"/>
+ </response>
+ <response status="400 401 403 404 500 503">
+ <representation mediaType="application/json"/>
+ </response>
+ </method>
+
+ <method name="DELETE" id="revokeToken">
+ <response status="204"/>
+ <response status="401">
+ <representation mediaType="application/xml" element="idm:unauthorized"/>
+ </response>
+ <response status="403">
+ <representation mediaType="application/xml" element="idm:forbidden"/>
+ </response>
+ <response status="400">
+ <representation mediaType="application/xml" element="idm:badRequest"/>
+ </response>
+ <response status="404">
+ <representation mediaType="application/xml" element="idm:itemNotFound"/>
+ </response>
+ <response status="500">
+ <representation mediaType="application/xml" element="idm:idmFault"/>
+ </response>
+ <response status="503">
+ <representation mediaType="application/xml" element="idm:serviceUnavailable"/>
+ </response>
+ <response status="400 401 403 404 500 503">
+ <representation mediaType="application/json"/>
+ </response>
+ </method>
+
+</application>