Merge pull request #24 from yogirackspace/master

Doc changes.

5 files changed, 206 insertions, 16 deletions

diff --git a/docs/guide/src/docbkx/identitydevguide.xml b/docs/guide/src/docbkx/identitydevguide.xml
index 5af5c532..e0e9ef11 100644..100755
--- a/docs/guide/src/docbkx/identitydevguide.xml
+++ b/docs/guide/src/docbkx/identitydevguide.xml
@@ -133,15 +133,6 @@
 		and operators. Tenant administrators may assign roles to users.
 	  </para>
 	</section>
-	<section>
-		<title>Group</title>
-		<para>
-			A group of users. Groups may be used to organize and assign
-            privileges to a group of related users. For example, an operator
-            may create a "delinquent" group, which will assign limited
-			privileges to users who have past due bills.
-		</para>
-	</section>
   </chapter>
   <chapter>
 	<title>General API Information</title>
@@ -859,6 +850,54 @@ Host: identity.api.openstack.org/v1.1/
 	  <title>Core Admin API Proposal</title>
 	  <note>The following table of calls is proposed as core Keystone Admin APIs</note>
           <section>
+             <title>Users</title>
+			 <informaltable rules="all">
+			 &LONG_URI_REFHEAD;
+			 <tbody>
+			   <tr>
+				 <td colspan="1"> &PUT; </td>
+				 <td colspan="4">/users</td>
+				 <td colspan="3">Create a User.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &GET; </td>
+				 <td colspan="4">/users</td>
+				 <td colspan="3">Get a list of users.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &GET; </td>
+				 <td colspan="4">/users/<parameter>userId</parameter></td>
+				 <td colspan="3">Get a user.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &PUT; </td>
+				 <td colspan="4">/users/<parameter>userId</parameter></td>
+				 <td colspan="3">Update a user.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &DELETE; </td>
+				 <td colspan="4">/users/<parameter>userId</parameter></td>
+				 <td colspan="3">Delete a user.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &PUT; </td>
+				 <td colspan="4">/users/<parameter>userId</parameter>/<parameter>password</parameter></td>
+				 <td colspan="3">Update a user password.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &PUT; </td>
+				 <td colspan="4">/users/<parameter>userId</parameter>/<parameter>enabled</parameter></td>
+				 <td colspan="3">Enable/Disable user.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &PUT; </td>
+				 <td colspan="4">/users/<parameter>userId</parameter>/<parameter>tenant</parameter></td>
+				 <td colspan="3">Update user tenant.</td>
+			   </tr>			   
+			 </tbody>
+			 </informaltable>
+          </section>   
+          <section>
              <title>Tokens</title>
 			 <informaltable rules="all">
 			 &LONG_URI_REFHEAD;
@@ -887,15 +926,36 @@ Host: identity.api.openstack.org/v1.1/
 				 <td colspan="4">/tenants</td>
 				 <td colspan="3">Get a list of tenants.</td>
 			   </tr>
-			<tr>
-			  <td colspan="1"> &GET; </td>
-			  <td colspan="4">/tenants/<parameter>tenantId</parameter></td>
-			  <td colspan="3">Get a tenant.</td>
-			</tr>
+			 <tr>
+			   <td colspan="1"> &GET; </td>
+			   <td colspan="4">/tenants/<parameter>tenantId</parameter></td>
+			   <td colspan="3">Get a tenant.</td>
+			 </tr>
+			   <tr>
+				 <td colspan="1"> &PUT; </td>
+				 <td colspan="4">/tenants</td>
+				 <td colspan="3">Create a tenant.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &PUT; </td>
+				 <td colspan="4">/tenants/<parameter>tenantId</parameter></td>
+				 <td colspan="3">Update a tenant.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &DELETE; </td>
+				 <td colspan="4">/tenants/<parameter>tenantId</parameter></td>
+				 <td colspan="3">Delete a tenant.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &GET; </td>
+				 <td colspan="4">/tenants/<parameter>tenantId</parameter>/users</td>
+				 <td colspan="3">get tenant users.</td>
+			   </tr>
+			   
 			 </tbody>
 			 </informaltable>
-          </section>   
-
+          </section>
+	  
           <section>
              <title>Endpoints (BaseURLs)</title>
 			 <informaltable rules="all">
@@ -1008,6 +1068,7 @@ Host: identity.api.openstack.org/v1.1/
 			 </tbody>
 			 </informaltable>
           </section>
+
 			 <important>All other APIs listed in this section will be extensions used for this
 			 reference implementation of Keystone to support user and tenant management</important>
 	  </section>
@@ -1676,4 +1737,122 @@ Host: identity.api.openstack.org/v1.1/
 			</section>
 	   </section>
   </chapter>
+  
+  <chapter>
+	<title>Appendix</title>
+	  <section>
+	  <title>Rackspace Extenison Proposal</title>
+			 <section>
+			   <title>Concepts</title>
+			     <para>
+				 The concepts that are specific to rackspace extensions are:
+			       </para>
+				<section>		  
+				 <title>Group</title>
+				 <para>
+					 A group of users. Groups may be used to organize and assign
+			     privileges to a group of related users. For example, an operator
+			     may create a "delinquent" group, which will assign limited
+					 privileges to users who have past due bills.
+				 </para>
+				 </section>
+			 </section>
+
+			 <note>The following table of calls is proposed as rackspace specific extensions for Keystone APIs</note>
+			 	  
+			 <section>
+				 <title>Global Groups</title>
+					     <informaltable rules="all">
+					     &LONG_URI_REFHEAD;
+					     <tbody>
+					       <tr>
+						     <td colspan="1"> &PUT; </td>
+						     <td colspan="4">/groups</td>
+						     <td colspan="3">Create a global group.</td>
+					       </tr>
+					       <tr>
+						     <td colspan="1"> &GET; </td>
+						     <td colspan="4">/groups</td>
+						     <td colspan="3">Get a list of global groups.</td>
+					       </tr>
+					       <tr>
+						     <td colspan="1"> &GET; </td>
+						     <td colspan="4">/groups/<parameter>groupId</parameter></td>
+						     <td colspan="3">Get a global group.</td>
+					       </tr>
+					       <tr>
+						     <td colspan="1"> &PUT; </td>
+						     <td colspan="4">/groups/<parameter>groupId</parameter></td>
+						     <td colspan="3">Update a global group.</td>
+					       </tr>
+					       <tr>
+						     <td colspan="1"> &DELETE; </td>
+						     <td colspan="4">/groups<parameter>/groupId</parameter></td>
+						     <td colspan="3">Delete a global group.</td>
+					       </tr>
+					       <tr>
+						     <td colspan="1"> &GET; </td>
+						     <td colspan="4">/groups/<parameter>groupId</parameter>/users</td>
+						     <td colspan="3">Get a list of users of a global group.</td>
+					       </tr>
+					       <tr>
+						     <td colspan="1"> &PUT; </td>
+						     <td colspan="4">/groups/<parameter>groupId</parameter>/users/<parameter>userId</parameter></td>
+						     <td colspan="3">Add user to a global group.</td>
+					       </tr>
+					       <tr>
+						     <td colspan="1"> &DELETE; </td>
+						     <td colspan="4">/groups/<parameter>groupId</parameter>/users/<parameter>userId</parameter></td>
+						     <td colspan="3">Delete user from a global group.</td>
+					       </tr>
+					     </tbody>
+					     </informaltable>
+			      </section>
+                              <section>
+             <title>Tenant Groups</title>
+			 <informaltable rules="all">
+			 &LONG_URI_REFHEAD;
+			 <tbody>
+			   <tr>
+				 <td colspan="1"> &GET; </td>
+				 <td colspan="4">/tenants/<parameter>tenantId</parameter>/groups</td>
+				 <td colspan="3">Get a list of tenant groups.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &POST; </td>
+				 <td colspan="4">/tenants/<parameter>tenantId</parameter>/groups</td>
+				 <td colspan="3">Create a tenant group.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &GET; </td>
+				 <td colspan="4">/tenants/<parameter>tenantId</parameter>/groups/<parameter>groupId</parameter></td>
+				 <td colspan="3">Get a tenant group with the specified id.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &PUT; </td>
+				 <td colspan="4">/tenants/<parameter>tenantId</parameter>/groups/<parameter>groupId</parameter></td>
+				 <td colspan="3">Update a tenant group.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &GET; </td>
+				 <td colspan="4">/tenants/<parameter>tenantId</parameter>/groups/<parameter>groupId</parameter>/users</td>
+				 <td colspan="3">get tenant group users.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &PUT; </td>
+				 <td colspan="4">/tenants/<parameter>tenantId</parameter>/groups/<parameter>groupId</parameter>/users/<parameter>userId</parameter></td>
+				 <td colspan="3">Add a user to a tenant group.</td>
+			   </tr>
+			   <tr>
+				 <td colspan="1"> &DELETE; </td>
+				 <td colspan="4">/tenants/<parameter>tenantId</parameter>/groups/<parameter>groupId</parameter>/users/<parameter>userId</parameter></td>
+				 <td colspan="3">Delete  user tenant group.</td>
+			   </tr>
+			 </tbody>
+			 </informaltable>
+          </section>
+	  			 
+	  </section>
+  </chapter>
+  
 </book>
diff --git a/docs/guide/src/docbkx/samples/group.json b/docs/guide/src/docbkx/samples/group.json
new file mode 100644
index 00000000..07dc0a10
--- /dev/null
+++ b/docs/guide/src/docbkx/samples/group.json
@@ -0,0 +1 @@
+{"group": {"id": "test_global_group", "description": "A description ..."}}
\ No newline at end of file
diff --git a/docs/guide/src/docbkx/samples/group.xml b/docs/guide/src/docbkx/samples/group.xml
new file mode 100644
index 00000000..0f285307
--- /dev/null
+++ b/docs/guide/src/docbkx/samples/group.xml
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<group xmlns="http://docs.openstack.org/identity/api/v2.0" id="test group">
+    <description>A Description of the group</description>
+</group>
diff --git a/docs/guide/src/docbkx/samples/groups.json b/docs/guide/src/docbkx/samples/groups.json
new file mode 100644
index 00000000..06dd58a0
--- /dev/null
+++ b/docs/guide/src/docbkx/samples/groups.json
@@ -0,0 +1 @@
+{"groups": {"values": [{"id": "test_global_group_add", "description": "A description ..."}], "links": []}}
\ No newline at end of file
diff --git a/docs/guide/src/docbkx/samples/groups.xml b/docs/guide/src/docbkx/samples/groups.xml
new file mode 100644
index 00000000..a429fdb3
--- /dev/null
+++ b/docs/guide/src/docbkx/samples/groups.xml
@@ -0,0 +1,5 @@
+<groups xmlns="http://docs.openstack.org/identity/api/v2.0">
+    <group xmlns="http://docs.openstack.org/identity/api/v2.0" id="test_global_group_add">
+        <description>A Description of the group</description>
+    </group>
+</groups>