From ffdd0cd2457aec55f0cdb30d49c3e52b950381e5 Mon Sep 17 00:00:00 2001
From: Ziad Sawalha <github@highbridgellc.com>
Date: Thu, 11 Aug 2011 13:04:58 -0500
Subject: Schema and WADL updates

Change-Id: I6e8d0efa2395178ce58692b2f117040833bbb1ef
---
 keystone/content/identity.wadl     | 64 ++++++++++++++---------------
 keystone/content/xsd/endpoints.xsd | 14 +++----
 keystone/content/xsd/tenant.xsd    | 82 +++++++++++++++++++++++++++++---------
 3 files changed, 102 insertions(+), 58 deletions(-)

diff --git a/keystone/content/identity.wadl b/keystone/content/identity.wadl
index 184bb573..9bc6a3c1 100644
--- a/keystone/content/identity.wadl
+++ b/keystone/content/identity.wadl
@@ -37,7 +37,7 @@
                 </resource>
             </resource>
             <resource id="tenants" path="tenants">
-                <param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
+								<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
                 <method href="#getTenants" />
                 <method href="#createTenant" />
                 <resource id="tenantId" path="{tenantId}">
@@ -58,72 +58,70 @@
             </resource>
 
             <resource id="users" path="users">
-		<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
+								<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
                 <method href="#getUsers" />
                 <method href="#createUser" />
                 <resource id="userId" path="{userId}">
-		    <param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
+										<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
                     <param name="userId" style="template" type="xsd:string"/>
                     <method href="#getUser" />
                     <method href="#updateUser" />
                     <method href="#deleteUser" />
-                <resource id="enabled" path="enabled">
-                    <method href="#setUserEnabled"/>
-                </resource>
-                <resource id="password" path="password">
-                    <method href="#setUserPassword"/>
-                </resource>
-                <resource id="tenant" path="tenant">
-                    <method href="#setUserTenant"/>
-                </resource>
-	            <resource id="roleRefs" path="roleRefs">
-    	            <method href="#getRoleRefs"/>
-	    	        <method href="#addRoleRef"/>
-                	<resource id="roleRef" path="{roleId}">
-	                	<param name="roleId" style="template" type="xsd:int"/>
-    	                <method href="#getRoleRef"/>
-	    	            <method href="#deleteRoleRef"/>
-    	    	    </resource>
-                </resource>
-		</resource>
-	    </resource>
+										<resource id="enabled" path="enabled">
+												<method href="#setUserEnabled"/>
+										</resource>
+										<resource id="password" path="password">
+												<method href="#setUserPassword"/>
+										</resource>
+										<resource id="tenant" path="tenant">
+												<method href="#setUserTenant"/>
+										</resource>
+										<resource id="roleRefs" path="roleRefs">
+												<method href="#getRoleRefs"/>
+												<method href="#addRoleRef"/>
+												<resource id="roleRef" path="{roleId}">
+														<param name="roleId" style="template" type="xsd:int"/>
+														<method href="#getRoleRef"/>
+														<method href="#deleteRoleRef"/>
+												</resource>
+										</resource>
+								</resource>
+						</resource>
 	    
             <resource id="endpointTemplates" path="endpointTemplates">
-		<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
+								<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
                 <method href="#getEndpointTemplates"/>
                 <method href="#addEndpointTemplate"/>
                 <resource id="endpointTemplateId" path="{endpointTemplateId}">
-		    <param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
+										<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
                     <param name="endpointTemplateId" style="template" type="xsd:int"/>
                     <method href="#getEndpointTemplate"/>
                     <method href="#deleteEndpointTemplate"/>
                 </resource>
             </resource>
-	    
-        <resource id="roles" path="roles">
-		<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
+						<resource id="roles" path="roles">
+								<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
                 <method href="#getRoles"/>
                 <method href="#addRole"/>
                 <resource id="roleId" path="{roleId}">
-		    <param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
+										<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
                     <param name="roleId" style="template" type="xsd:int"/>
                     <method href="#getRole"/>
                     <method href="#deleteRole"/>
                 </resource>
             </resource>
 
-        <resource id="services" path="services">
-		<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
+						<resource id="services" path="services">
+								<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
                 <method href="#getServices"/>
                 <method href="#addService"/>
                 <resource id="serviceId" path="{serviceId}">
-		    <param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
+										<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
                     <param name="serviceId" style="template" type="xsd:int"/>
                     <method href="#getService"/>
                     <method href="#deleteService"/>
                 </resource>
             </resource>
-	    
         </resource>
     </resources>
 
diff --git a/keystone/content/xsd/endpoints.xsd b/keystone/content/xsd/endpoints.xsd
index 7044e173..0eda3242 100644
--- a/keystone/content/xsd/endpoints.xsd
+++ b/keystone/content/xsd/endpoints.xsd
@@ -3,7 +3,7 @@
         elementFormDefault="qualified"
         attributeFormDefault="unqualified"
     xmlns="http://www.w3.org/2001/XMLSchema"
-    xmlns:idm="http://docs.openstack.org/identity/api/v2.0"
+    xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
     xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning"
     xmlns:atom="http://www.w3.org/2005/Atom"
@@ -14,7 +14,7 @@
     <import vc:minVersion="1.1" namespace="http://www.w3.org/2005/Atom"
             schemaLocation="atom/atom.xsd" />
 
-    <element name="endpointTemplates" type="idm:EndpointTemplateList">
+    <element name="endpointTemplates" type="identity:EndpointTemplateList">
         <annotation>
             <xsd:documentation
                     xml:lang="EN"
@@ -26,7 +26,7 @@
         </annotation>
     </element>
     
-    <element name="endpointTemplate" type="idm:EndpointTemplate">
+    <element name="endpointTemplate" type="identity:EndpointTemplate">
         <annotation>
             <xsd:documentation
                     xml:lang="EN"
@@ -37,7 +37,7 @@
             </xsd:documentation>
         </annotation>
     </element>
-    <element name="endpoint" type="idm:Endpoint">
+    <element name="endpoint" type="identity:Endpoint">
         <annotation>
             <xsd:documentation
                     xml:lang="EN"
@@ -48,7 +48,7 @@
             </xsd:documentation>
         </annotation>
     </element>
-    <element name="endpoints" type="idm:EndpointList">
+    <element name="endpoints" type="identity:EndpointList">
         <annotation>
             <xsd:documentation
                     xml:lang="EN"
@@ -182,7 +182,7 @@
 
     <complexType name="EndpointTemplateList">
         <sequence>
-            <element name="endpointTemplate" type="idm:EndpointTemplate" minOccurs="0" maxOccurs="unbounded"/>
+            <element name="endpointTemplate" type="identity:EndpointTemplate" minOccurs="0" maxOccurs="unbounded"/>
             <element vc:minVersion="1.1" ref="atom:link" minOccurs="0" maxOccurs="unbounded" />
             <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" />
         </sequence>
@@ -191,7 +191,7 @@
 
     <complexType name="EndpointList">
         <sequence>
-            <element name="endpoint" type="idm:Endpoint" minOccurs="0" maxOccurs="unbounded"/>
+            <element name="endpoint" type="identity:Endpoint" minOccurs="0" maxOccurs="unbounded"/>
             <element vc:minVersion="1.1" ref="atom:link" minOccurs="0" maxOccurs="unbounded" />
             <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" />
         </sequence>
diff --git a/keystone/content/xsd/tenant.xsd b/keystone/content/xsd/tenant.xsd
index 8ac7099e..4acd1a8d 100644
--- a/keystone/content/xsd/tenant.xsd
+++ b/keystone/content/xsd/tenant.xsd
@@ -15,23 +15,14 @@
             schemaLocation="atom/atom.xsd" />
 
     <!-- Elements -->
-    <element name="tenant" type="identity:Tenant"  />
-    <element name="tenants" type="identity:Tenants" />
-
-    <!-- Complex Types -->
-    <complexType name="Tenants">
-        <sequence>
-            <element name="tenant" type="identity:Tenant" maxOccurs="1000"/>
-            <element vc:minVersion="1.1" ref="atom:link" minOccurs="0" maxOccurs="unbounded" />
-            <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" />
-        </sequence>
-        <anyAttribute namespace="##other" processContents="lax"/>
-    </complexType>
-
-    <complexType name="Tenant">
+    <element name="tenant" type="identity:Tenant">
         <annotation>
             <documentation xml:lang="EN" xmlns="http://www.w3.org/1999/xhtml">
-                <p>This is ....</p>
+                <p>
+                  A container used to group or isolate resources and/or identity
+                  objects. Depending on the service operator, a tenant may map to a customer,
+                  account, organization, or project.
+                </p>
             </documentation>
             <xsd:appinfo>
               <xsdxt:samples>
@@ -44,12 +35,67 @@
               </xsdxt:samples>
             </xsd:appinfo>
         </annotation>
+    </element>  
+    <element name="tenants" type="identity:Tenants">
+       <annotation>
+            <xsd:documentation
+                    xml:lang="EN"
+                    xmlns="http://www.w3.org/1999/xhtml">
+                <p>
+                    A list of tenants.
+                </p>
+            </xsd:documentation>
+        </annotation>
+    </element>  
+
+    <!-- Complex Types -->
+    <complexType name="Tenants">
+        <sequence>
+            <element name="tenant" type="identity:Tenant" maxOccurs="1000"/>
+            <element vc:minVersion="1.1" ref="atom:link" minOccurs="0" maxOccurs="unbounded" />
+            <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" />
+        </sequence>
+        <anyAttribute namespace="##other" processContents="lax"/>
+    </complexType>
+
+    <complexType name="Tenant">
         <sequence>
-            <element name="description" type="xsd:string"/>
+            <element name="description" type="xsd:string">
+                <annotation>
+                    <xsd:documentation
+                            xml:lang="EN"
+                            xmlns="http://www.w3.org/1999/xhtml">
+                        <p>
+                            An free text description of the tenant.
+                        </p>
+                    </xsd:documentation>
+                </annotation>
+            </element>
             <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" />
         </sequence>
-        <attribute name="enabled" type="xsd:boolean" use="optional" default="true"/>
-        <attribute name="id" type="xsd:string" use="optional"/>
+        <attribute name="enabled" type="xsd:boolean" use="optional" default="true">
+            <annotation>
+                <xsd:documentation
+                        xml:lang="EN"
+                        xmlns="http://www.w3.org/1999/xhtml">
+                    <p>
+                        An boolean signifying if a tenant is enmabled or not. A disabled tenant
+                        cannot be authenticated against.
+                    </p>
+                </xsd:documentation>
+            </annotation>
+        </attribute>
+        <attribute name="id" type="xsd:string" use="optional">
+            <annotation>
+                <xsd:documentation
+                        xml:lang="EN"
+                        xmlns="http://www.w3.org/1999/xhtml">
+                    <p>
+                        An ID uniquely identifying the tenant.
+                    </p>
+                </xsd:documentation>
+            </annotation>
+        </attribute>
         <anyAttribute namespace="##other" processContents="lax"/>
     </complexType>
 </schema>
-- 
cgit