From 64bfcfea2e90f1a1baa7d8b68fed60525da51a82 Mon Sep 17 00:00:00 2001 From: Yogeshwar Srikrishnan Date: Thu, 1 Sep 2011 12:09:00 -0500 Subject: Adding wadl for OS-KSCATALOG extension.Fixing existing xsds.Fixing service wadls. Merging changes. Change-Id: Id29dc19cbc89f47e21329e531fc33bd66c14cf61 --- keystone/content/admin/OS-KSADM-admin.wadl | 443 ++++++ keystone/content/admin/OS-KSCATALOG-admin.wadl | 165 +++ keystone/content/admin/RAX-KSKEY-admin.wadl | 251 ---- .../content/admin/identity-admin-OS-KSADM.wadl | 640 --------- .../content/admin/identity-admin-RAX-KSADM.wadl | 1455 -------------------- .../common/xsd/OS-KSCATALOG-endpointtemplates.xsd | 150 ++ .../content/common/xsd/RAX-KSADM-credentials.xsd | 1 - keystone/content/common/xsd/RAX-KSADM-groups.xsd | 47 - keystone/content/common/xsd/credentials.xsd | 29 +- keystone/content/common/xsd/token.xsd | 91 +- keystone/content/service/identity.wadl | 1 - 11 files changed, 786 insertions(+), 2487 deletions(-) create mode 100644 keystone/content/admin/OS-KSADM-admin.wadl create mode 100644 keystone/content/admin/OS-KSCATALOG-admin.wadl delete mode 100644 keystone/content/admin/RAX-KSKEY-admin.wadl delete mode 100644 keystone/content/admin/identity-admin-OS-KSADM.wadl delete mode 100644 keystone/content/admin/identity-admin-RAX-KSADM.wadl create mode 100644 keystone/content/common/xsd/OS-KSCATALOG-endpointtemplates.xsd delete mode 100644 keystone/content/common/xsd/RAX-KSADM-groups.xsd diff --git a/keystone/content/admin/OS-KSADM-admin.wadl b/keystone/content/admin/OS-KSADM-admin.wadl new file mode 100644 index 00000000..bcfc07cf --- /dev/null +++ b/keystone/content/admin/OS-KSADM-admin.wadl @@ -0,0 +1,443 @@ + + + + + + + + + + %common; +]> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + You need a valid admin token for access. + + + + + + + + + + + + + + You need a valid admin token for access. + + + + + + + + + + + + + + + + + You need a valid admin token for access. + + + + + 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; +
+ + + + + +

+ Authenticate to generate a token. +

+

+ This call will return a token if successful. Each ReST request against other services (or other + calls on Keystone such as the GET /tenants call) + requires the inclusion of a specific authorization token HTTP x-header, defined as X-Auth-Token. + Clients obtain + this token, along with the URL to other service APIs, by first authenticating against the + Keystone Service and supplying valid credentials. +

+

+ Client authentication is provided via a ReST interface using the POST method, + with v2.0/tokens supplied as the path. A payload of credentials must be included + in the body. +

+

+ The Keystone Service is a ReSTful web service. It is the entry point to all service APIs. + To access the Keystone Service, you must know URL of the Keystone service. +

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

+ Check that a token is valid and that it belongs to a particular user + and return the permissions relevant to a particular client. +

+

+ Valid tokens will exist in the + /tokens/{tokenId} path and invalid + tokens will not. In other words, a user should expect an + itemNotFound (404) fault for an + invalid token. +

+ + + + +
+ + + +

+ Validates a token has the supplied tenant in scope. +

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

+ Check that a token is valid and that it belongs to a particular user + (For perfromance). +

+
+ + + +

+ Validates a token has the supplied tenant in scope. (for performance). +

+

+ Valid tokens will exist in the + /tokens/{tokenId} path and invalid + tokens will not. In other words, a user should expect an + itemNotFound (404) fault for an + invalid token. +

+

+ If `belongsTo` is provided, validates that a token has a specific tenant in scope. +

+

+ No response body is returned for this method. +

+
+ +
+ + + + + &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). +

+

Returns a list of global roles associated with a specific + user (excludes tenant roles).

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

+ Get a list of tenants. +

+

+ The operation returns a list of tenants which the supplied token provides + access to. This call must be authenticated, so a valid token must + be passed in as a header. +

+ + + + + + + +
+ + + + + + + + + &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 token. +

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

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

+ + + + +
+ + + + + &commonFaults; + &getFaults; +
+
diff --git a/keystone/content/admin/OS-KSCATALOG-admin.wadl b/keystone/content/admin/OS-KSCATALOG-admin.wadl new file mode 100644 index 00000000..0217fb08 --- /dev/null +++ b/keystone/content/admin/OS-KSCATALOG-admin.wadl @@ -0,0 +1,165 @@ + + + + + + + + + + +%common; +]> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + &commonFaults; + &getFaults; + + + + + + + + &commonFaults; + &getFaults; + + + + + + + + + + + + + + + + &commonFaults; + &getFaults; + &postPutFaults; + + + + + &commonFaults; + &getFaults; + + + + + + + + + + + + + + + + &commonFaults; + &getFaults; + &postPutFaults; + + + + + + + + &commonFaults; + &getFaults; + + + + + + + + &commonFaults; + &getFaults; + + + + + &commonFaults; + &getFaults; + + diff --git a/keystone/content/admin/RAX-KSKEY-admin.wadl b/keystone/content/admin/RAX-KSKEY-admin.wadl deleted file mode 100644 index 339db5d8..00000000 --- a/keystone/content/admin/RAX-KSKEY-admin.wadl +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - - - - - %common; -]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- Adds a valid apikeyCredentials. -

-
- - - - - - - - - - - - - &commonFaults; - &postPutFaults; -
- - - - -

- Retrieves a token. -

-

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

-
- - - -

- Validates a token has the supplied tenant in scope. -

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

- Validates a token exists (for performance). -

-
- - - -

- Validates a token has the supplied tenant in scope. (for performance). -

-

- If `belongsTo` is provided, validates that a token has a specific tenant in scope. -

-
- -
- - - - - &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. -

-
- - - - - - - - - &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 token. -

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

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

-
- - - - - &commonFaults; - &getFaults; -
-
diff --git a/keystone/content/admin/identity-admin-OS-KSADM.wadl b/keystone/content/admin/identity-admin-OS-KSADM.wadl deleted file mode 100644 index 7d74013b..00000000 --- a/keystone/content/admin/identity-admin-OS-KSADM.wadl +++ /dev/null @@ -1,640 +0,0 @@ - - - - - - - - - - -%common; -]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- 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.

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

Gets details about a specific tenant.

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

Creates a tenant.

-
- - - - - - - - - &commonFaults; -
- - - - - - - - - - &commonFaults; - &getFaults; - - - - &commonFaults; - &getFaults; - - - - - - - - - - - - - &commonFaults; - &getFaults; - - - - - - - - - - - &commonFaults; - &getFaults; - - - - - - - &commonFaults; - &getFaults; - - - - - - - &commonFaults; - &getFaults; - - - - - - - - - - - &commonFaults; - &getFaults; - - - - &commonFaults; - &getFaults; - - - - - - - - - - - - - &commonFaults; - &getFaults; - - - - - - - - - - - - - &commonFaults; - &getFaults; - - - - - - - - - - - - - &commonFaults; - &getFaults; - - - - - - - - - - &commonFaults; - &getFaults; - - - - - - - &commonFaults; - &getFaults; - - - - - - - - - - - - - - - &commonFaults; - &getFaults; - - - - &commonFaults; - &getFaults; - - - - - - - &commonFaults; - &getFaults; - - - - - - - - - - - - - - - &commonFaults; - &getFaults; - - - - - - - &commonFaults; - &getFaults; - - - - &commonFaults; - &getFaults; - - - - - - - - - - - - &commonFaults; - &getFaults; - - - - - - - &commonFaults; - &getFaults; - - - - - - - - - - - - - - - &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-RAX-KSADM.wadl b/keystone/content/admin/identity-admin-RAX-KSADM.wadl deleted file mode 100644 index 4d39e3b6..00000000 --- a/keystone/content/admin/identity-admin-RAX-KSADM.wadl +++ /dev/null @@ -1,1455 +0,0 @@ - - - - - - - - - - - %common; -]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - You need an admin token to execute this operation. The token must be valid... - - - - - - - - - - - - - - - - - - - - - -

- A list of supported extensions. -

-
- -
- - - - - - - - - - -

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

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -

- List all available extensions. -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -

- Get details about a specific extension. -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
diff --git a/keystone/content/common/xsd/OS-KSCATALOG-endpointtemplates.xsd b/keystone/content/common/xsd/OS-KSCATALOG-endpointtemplates.xsd new file mode 100644 index 00000000..20afd735 --- /dev/null +++ b/keystone/content/common/xsd/OS-KSCATALOG-endpointtemplates.xsd @@ -0,0 +1,150 @@ + + + + + + + + + + + + + +

+ A list of Endpoint Templates. +

+
+
+
+ + + + +

+ An Endpoint Template. +

+
+
+
+ + + + + + +

+ An ID uniquely identifying the Endpoint Template. +

+
+
+
+ + + +

+ The service name of Endpoint Template. +

+
+
+
+ + + +

+ The region of Endpoint Template. +

+
+
+
+ + + +

+ The public URL to access represented service. +

+
+
+
+ + + +

+ The internal version of the public URL. +

+
+
+
+ + + +

+ The admin URL. +

+
+
+
+ + + +

+ If true the Endpoint Template is automatically part of every account. +

+
+
+
+ + + +

+ True if the Endpoint Template is enabled (active). + A Endpoint Template cannot be added if it's disabled or inactive (false). +

+
+
+
+ +
+ + + + + + + + + + +
diff --git a/keystone/content/common/xsd/RAX-KSADM-credentials.xsd b/keystone/content/common/xsd/RAX-KSADM-credentials.xsd index c849afe1..3f9fd126 100644 --- a/keystone/content/common/xsd/RAX-KSADM-credentials.xsd +++ b/keystone/content/common/xsd/RAX-KSADM-credentials.xsd @@ -27,7 +27,6 @@ - diff --git a/keystone/content/common/xsd/RAX-KSADM-groups.xsd b/keystone/content/common/xsd/RAX-KSADM-groups.xsd deleted file mode 100644 index 6f9b1f27..00000000 --- a/keystone/content/common/xsd/RAX-KSADM-groups.xsd +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/keystone/content/common/xsd/credentials.xsd b/keystone/content/common/xsd/credentials.xsd index fcfc0dae..f873489b 100644 --- a/keystone/content/common/xsd/credentials.xsd +++ b/keystone/content/common/xsd/credentials.xsd @@ -12,8 +12,13 @@ xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0" xmlns:atom="http://www.w3.org/2005/Atom" - targetNamespace="http://docs.openstack.org/identity/api/v2.0" + targetNamespace="http://docs.openstack.org/identity/api/v2.0" > + + + + @@ -35,16 +40,16 @@ + - - - - - + + + + @@ -53,6 +58,7 @@ + @@ -61,6 +67,7 @@ + @@ -68,5 +75,13 @@ - + + + + + + + + + diff --git a/keystone/content/common/xsd/token.xsd b/keystone/content/common/xsd/token.xsd index a7ff8d28..01187dfe 100644 --- a/keystone/content/common/xsd/token.xsd +++ b/keystone/content/common/xsd/token.xsd @@ -15,6 +15,7 @@ targetNamespace="http://docs.openstack.org/identity/api/v2.0" > + + @@ -107,7 +109,7 @@ - + - + + @@ -163,6 +166,7 @@ + @@ -217,88 +221,5 @@ - - - - - -

- An extensible service type allows all of the - strings defined in ServiceType or an - alias prefixed status. -

-
-
- -
- - - - - - -

- The type for an OpenStack Compute API 1.1 compatible service. -

-
-
-
- - - -

- The type for a Swift-compatible service. -

-
-
-
- - - -

- The type for a Glance-compatible service -

-
-
-
- - - -

- The type for a Keystone-compatible service. -

-
-
-
-
-
- - - - -

- A non-core service type which must contain an extension prefix. -

-
-
- - - -
- diff --git a/keystone/content/service/identity.wadl b/keystone/content/service/identity.wadl index 7f0f1a1c..746b2087 100644 --- a/keystone/content/service/identity.wadl +++ b/keystone/content/service/identity.wadl @@ -46,7 +46,6 @@ - -- cgit