From c256b7c7d5f5402d12681efd0f6d81c24e2fc933 Mon Sep 17 00:00:00 2001 From: Dolph Mathews Date: Tue, 16 Aug 2011 17:43:03 -0500 Subject: Admin WADL Revisions - Based on http://etherpad.openstack.org/KeystoneV2APIcore - Switched to imported faults - Revised method identifiers - Documented all methods Change-Id: I122da8ca052e564f47bf2a60adeacce332af01e3 --- keystone/content/admin/identity-admin-OS.wadl | 884 ++++++++------- keystone/content/admin/identity-admin.wadl | 1471 ++++--------------------- keystone/content/common/common.ent | 12 +- keystone/routers/admin.py | 2 + 4 files changed, 633 insertions(+), 1736 deletions(-) diff --git a/keystone/content/admin/identity-admin-OS.wadl b/keystone/content/admin/identity-admin-OS.wadl index 23aa23d7..da8a2aa3 100644 --- a/keystone/content/admin/identity-admin-OS.wadl +++ b/keystone/content/admin/identity-admin-OS.wadl @@ -4,135 +4,291 @@ - + - %common; + +%common; ]> + + xmlns:identity="http://docs.openstack.org/identity/api/v2.0" + xmlns:capi="http://docs.openstack.org/common/api/v2.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xsi:schemaLocation="http://docs.openstack.org/identity/api/v2.0 xsd/api.xsd + http://docs.openstack.org/common/api/v1.0 xsd/api-common.xsd + http://wadl.dev.java.net/2009/02 http://www.w3.org/Submission/wadl/wadl.xsd + "> + - - - - + + + + + + You need a valid admin token for access. + + + + + + + + + + + + + - - - - + + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + - - + + + + + + + + + + + + + + + - - - - - - - - - - + + + + + + + + + - - + + - - - + + + + + + + + + + + + + + + + + - - - - - - - - - - - + + + + +

+ Returns detailed information about this specific version of the API. +

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

Lists supported extensions.

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

Gets details about a specific extension.

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

Authenticates you with the service.

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

Validates a service or admin token.

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

Invalidates an issued token.

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

Lists all tenants.

+
@@ -141,30 +297,24 @@
- - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; +
+ + +

Gets details about a specific tenant.

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

Creates a tenant.

+
@@ -173,53 +323,9 @@ - - - - - - - - - - - - - - - - - - - - - + &commonFaults;
- - - - - - - - - - - - - - - - - - - - - - - - - + @@ -228,56 +334,17 @@ - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; - - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; - - + + @@ -286,30 +353,10 @@ - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; - - + @@ -318,58 +365,26 @@ - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; + + + + + &commonFaults; + &getFaults; - - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; - - + @@ -378,54 +393,14 @@ - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; - - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; - @@ -437,29 +412,9 @@ - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; - @@ -471,29 +426,9 @@ - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; - @@ -505,31 +440,89 @@ - - - - - + &commonFaults; + &getFaults; + + + + + + + + - - + &commonFaults; + &getFaults; + + + + + - - + &commonFaults; + &getFaults; + + + + + + + + + + + + + - - + &commonFaults; + &getFaults; + + + + &commonFaults; + &getFaults; + + + + + - - + &commonFaults; + &getFaults; + + + + + + + + + + + + + - + &commonFaults; + &getFaults; + + + + - - - - + &commonFaults; + &getFaults; + + + + &commonFaults; + &getFaults; + + + + @@ -537,56 +530,19 @@ - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; - - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; - - - + + @@ -598,51 +554,89 @@ - - - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; + - - - - - + &commonFaults; + &getFaults; + + + + + - - + &commonFaults; + &getFaults; + + + + + + + + + + + + + - - + &commonFaults; + &getFaults; + + + + + - - + &commonFaults; + &getFaults; + + + + &commonFaults; + &getFaults; + + + + + + + + - - + &commonFaults; + &getFaults; + + + + + - + &commonFaults; + &getFaults; + + + + + + + + + + + + - + &commonFaults; + &getFaults; + + + + &commonFaults; + &getFaults; +
diff --git a/keystone/content/admin/identity-admin.wadl b/keystone/content/admin/identity-admin.wadl index 7c55f8cc..0665392e 100644 --- a/keystone/content/admin/identity-admin.wadl +++ b/keystone/content/admin/identity-admin.wadl @@ -7,19 +7,19 @@ - %common; + +%common; ]> + xmlns:identity="http://docs.openstack.org/identity/api/v2.0" + xmlns:capi="http://docs.openstack.org/common/api/v2.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xsi:schemaLocation="http://docs.openstack.org/identity/api/v2.0 xsd/api.xsd + http://docs.openstack.org/common/api/v1.0 xsd/api-common.xsd + http://wadl.dev.java.net/2009/02 http://www.w3.org/Submission/wadl/wadl.xsd + "> @@ -31,152 +31,82 @@ - - - You need a valid admin token for access. - - - + + + + + You need a valid admin token for access. + + + + + + - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - + + + + + + - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + - - - - - - - - - -

A list of supported extensions.

-
- -
- - + + -

Returns detailed information about this specific - version of the API.

+

+ Returns detailed information about this specific version of the API. +

@@ -186,44 +116,17 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults;
- + - + -

List all available extensions.

+

+ Lists supported extensions. +

@@ -236,86 +139,30 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + &commonFaults;
-

Get details about a specific extension.

+

+ Gets details about a specific extension. +

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

+ Returns a token in exchange for valid credentials. +

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

+ Validates a token. +

+

+ If `belongsTo` is provided, validates that a token belongs to a specific tenant. +

+

+ Returns token expiration, user info, and the user's roles for the given token. +

+
@@ -355,86 +196,79 @@ - - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults;
- + +

+ Validates a token (for performance). +

+

+ If `belongsTo` is provided, validates that a token belongs to a specific tenant. +

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

+ Returns detailed information about a specific user, by user name. +

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

+ Returns detailed information about a specific user, by user id. +

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

+ Returns global roles for a specific user (excludes tenant roles). +

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

+ Returns a list of all tenants. +

+
@@ -443,992 +277,59 @@
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + &commonFaults; + &getFaults; - + + +

+ Returns detailed information about a tenant, by name. +

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

+ Returns detailed information about a tenant, by id. +

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

+ Returns a list of endpoints associated with a specific tenant. +

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

+ Returns a list of roles for a user on a specific tenant. +

+
- - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + &commonFaults; + &getFaults; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
diff --git a/keystone/content/common/common.ent b/keystone/content/common/common.ent index dcd942e5..b492c5d2 100644 --- a/keystone/content/common/common.ent +++ b/keystone/content/common/common.ent @@ -9,8 +9,8 @@ - - + + @@ -21,10 +21,6 @@ - - - - @@ -32,6 +28,10 @@ + + + + '>