From 8a0fcd001f547d7efe3b25e997ba2010111cc839 Mon Sep 17 00:00:00 2001 From: Yogeshwar Srikrishnan Date: Thu, 8 Sep 2011 16:49:50 -0500 Subject: Adding initial document for OS-KSADM-admin extension.Related changes on wadl,json,xsd etc. Change-Id: Id95c35e189f992926e08d3e486361d65929f7dcc --- keystone/content/admin/OS-KSADM-admin.wadl | 208 ++++++++++++++++----- .../content/admin/identity-OS-KSADM-dev-guide.pdf | Bin 0 -> 219864 bytes keystone/content/admin/identity-admin.wadl | 20 +- .../content/common/samples/tenantwithoutid.json | 7 + .../content/common/samples/tenantwithoutid.xml | 5 + keystone/content/common/samples/users.json | 18 ++ keystone/content/common/samples/users.xml | 9 + .../common/samples/userwithenabledonly.json | 5 + .../content/common/samples/userwithenabledonly.xml | 3 + keystone/content/common/samples/userwithoutid.json | 7 + keystone/content/common/samples/userwithoutid.xml | 4 + keystone/content/common/xsd/user.xsd | 2 +- 12 files changed, 242 insertions(+), 46 deletions(-) create mode 100644 keystone/content/admin/identity-OS-KSADM-dev-guide.pdf create mode 100644 keystone/content/common/samples/tenantwithoutid.json create mode 100644 keystone/content/common/samples/tenantwithoutid.xml create mode 100644 keystone/content/common/samples/users.json create mode 100644 keystone/content/common/samples/users.xml create mode 100644 keystone/content/common/samples/userwithenabledonly.json create mode 100644 keystone/content/common/samples/userwithenabledonly.xml create mode 100644 keystone/content/common/samples/userwithoutid.json create mode 100644 keystone/content/common/samples/userwithoutid.xml diff --git a/keystone/content/admin/OS-KSADM-admin.wadl b/keystone/content/admin/OS-KSADM-admin.wadl index 2e6a1000..8e484d0b 100644 --- a/keystone/content/admin/OS-KSADM-admin.wadl +++ b/keystone/content/admin/OS-KSADM-admin.wadl @@ -62,12 +62,13 @@ - + - + + @@ -106,9 +107,9 @@ + - @@ -132,25 +133,20 @@ - - -

Lists all tenants.

-
- - - - - - - - - &commonFaults; - &getFaults; -
- - -

Creates a tenant.

+ +

+ Creates a tenant. +

+

This call creates a tenant.

+ + + + + + + +
@@ -164,9 +160,20 @@ &postPutFaults;
- - -

Updates a tenant.

+ + +

+ Updates a tenant. +

+

This call updates a tenant.

+ + + + + + + +
@@ -183,7 +190,10 @@ -

Deletes a tenant.

+

+ Deletes a tenant. +

+

This call deletes a tenant.

&commonFaults; @@ -192,7 +202,12 @@ +

Lists all the roles for a tenant.

Lists all the roles for a tenant.

+ + + +
@@ -207,8 +222,13 @@
- + +

Lists all the users for a tenant.

Lists all the users for a tenant.

+ + + +
@@ -225,6 +245,10 @@

Lists all the users with a specific role for a tenant.

+ + + +
@@ -262,6 +286,14 @@

Adds a user.

+ + + + + + + +
@@ -276,21 +308,17 @@ &postPutFaults;
- - -

Get user.

-
- - - - - &commonFaults; - &getFaults; -
- - +

Update a user.

+ + + + + + + +
@@ -317,6 +345,14 @@

Enable user.

+ + + + + + + +
@@ -337,6 +373,10 @@

List roles for a user.

+ + + +
@@ -361,7 +401,11 @@ -

Get a role.

+

Get information about a role that belongs to a user.

+ + + +
@@ -441,6 +485,19 @@ &getFaults;
+ + +

Delete credentials.

+
+ + + + + &commonFaults; + &postPutFaults; + &getFaults; +
+

Get user credentials.

@@ -457,9 +514,15 @@

List roles.

+ + + +
+ + @@ -471,9 +534,30 @@ -

Add role.

-
- +

Add a Role.

+ + + + + + + + + + +
+ + + + + + + + + + + + &commonFaults; &postPutFaults; &getFaults; @@ -482,6 +566,10 @@

Get a role.

+ + + +
@@ -503,8 +591,17 @@ + +

List services.

+ + + + +
+ + @@ -514,6 +611,13 @@ &getFaults;
+ +

Get a service.

+ + + + +
@@ -521,7 +625,20 @@ &commonFaults; &getFaults;
- + + +

Add a service.

+ + + + + + + + + + +
@@ -539,6 +656,9 @@ &getFaults;
+ +

Delete a service.

+
&commonFaults; &getFaults; diff --git a/keystone/content/admin/identity-OS-KSADM-dev-guide.pdf b/keystone/content/admin/identity-OS-KSADM-dev-guide.pdf new file mode 100644 index 00000000..e5ec2014 Binary files /dev/null and b/keystone/content/admin/identity-OS-KSADM-dev-guide.pdf differ diff --git a/keystone/content/admin/identity-admin.wadl b/keystone/content/admin/identity-admin.wadl index 6f1e2c53..2af24d56 100644 --- a/keystone/content/admin/identity-admin.wadl +++ b/keystone/content/admin/identity-admin.wadl @@ -25,6 +25,7 @@ + @@ -102,6 +103,23 @@
+ + + + + + + + + + +

+ A list of supported extensions. +

+
+ +
+ @@ -148,7 +166,7 @@ &commonFaults;
- +

Gets details about a specific extension.

diff --git a/keystone/content/common/samples/tenantwithoutid.json b/keystone/content/common/samples/tenantwithoutid.json new file mode 100644 index 00000000..63faba9c --- /dev/null +++ b/keystone/content/common/samples/tenantwithoutid.json @@ -0,0 +1,7 @@ +{ + "tenant": { + "name": "ACME corp", + "description": "A description ...", + "enabled": true + } +} diff --git a/keystone/content/common/samples/tenantwithoutid.xml b/keystone/content/common/samples/tenantwithoutid.xml new file mode 100644 index 00000000..3983684b --- /dev/null +++ b/keystone/content/common/samples/tenantwithoutid.xml @@ -0,0 +1,5 @@ + + + A description... + diff --git a/keystone/content/common/samples/users.json b/keystone/content/common/samples/users.json new file mode 100644 index 00000000..134d1972 --- /dev/null +++ b/keystone/content/common/samples/users.json @@ -0,0 +1,18 @@ +{ + "users": { + "values": [ + { + "id": "u1000", + "username": "jqsmith", + "email": "john.smith@example.org", + "enabled": true + }, { + "id": "u1001", + "username": "jqsmith", + "email": "john.smith@example.org", + "enabled": true + } + ], + "links":[] + } +} \ No newline at end of file diff --git a/keystone/content/common/samples/users.xml b/keystone/content/common/samples/users.xml new file mode 100644 index 00000000..28e5aa38 --- /dev/null +++ b/keystone/content/common/samples/users.xml @@ -0,0 +1,9 @@ + + + + + diff --git a/keystone/content/common/samples/userwithenabledonly.json b/keystone/content/common/samples/userwithenabledonly.json new file mode 100644 index 00000000..23265395 --- /dev/null +++ b/keystone/content/common/samples/userwithenabledonly.json @@ -0,0 +1,5 @@ +{ + "user": { + "enabled": true + } +} diff --git a/keystone/content/common/samples/userwithenabledonly.xml b/keystone/content/common/samples/userwithenabledonly.xml new file mode 100644 index 00000000..3a0af74b --- /dev/null +++ b/keystone/content/common/samples/userwithenabledonly.xml @@ -0,0 +1,3 @@ + + diff --git a/keystone/content/common/samples/userwithoutid.json b/keystone/content/common/samples/userwithoutid.json new file mode 100644 index 00000000..2a891811 --- /dev/null +++ b/keystone/content/common/samples/userwithoutid.json @@ -0,0 +1,7 @@ +{ + "user": { + "username": "jqsmith", + "email": "john.smith@example.org", + "enabled": true + } +} diff --git a/keystone/content/common/samples/userwithoutid.xml b/keystone/content/common/samples/userwithoutid.xml new file mode 100644 index 00000000..3e875beb --- /dev/null +++ b/keystone/content/common/samples/userwithoutid.xml @@ -0,0 +1,4 @@ + + diff --git a/keystone/content/common/xsd/user.xsd b/keystone/content/common/xsd/user.xsd index b0a1123e..cae6a546 100644 --- a/keystone/content/common/xsd/user.xsd +++ b/keystone/content/common/xsd/user.xsd @@ -45,7 +45,7 @@ - +