From b7647a2bd7ba6468f9c47da7e2ab2feb8bd18b10 Mon Sep 17 00:00:00 2001 From: Ziad Sawalha Date: Mon, 22 Aug 2011 22:02:43 -0500 Subject: Updates to samples, XSDs, and WADLs Change-Id: I89a89a362bd5aaf715f125916d193acf75067b32 --- .../content/admin/identity-admin-OS-KSADM.wadl | 6 +- keystone/content/admin/identity-admin.wadl | 13 +- .../admin/xsd/OS-KSADM-endpointtemplates.xsd | 150 +++++++++++++++++++++ keystone/content/admin/xsd/api-common.xsd | 3 +- keystone/content/admin/xsd/credentials.xsd | 82 ++++++----- keystone/content/admin/xsd/endpoints.xsd | 116 +++------------- keystone/content/admin/xsd/extensions.xsd | 2 + keystone/content/admin/xsd/fault.xsd | 2 + keystone/content/admin/xsd/roles.xsd | 7 +- keystone/content/admin/xsd/services.xsd | 5 +- keystone/content/admin/xsd/tenant.xsd | 10 +- keystone/content/admin/xsd/token.xsd | 5 +- keystone/content/admin/xsd/user.xsd | 29 ++-- keystone/content/common/samples/auth.json | 10 +- keystone/content/common/samples/ext-getuser.json | 1 - keystone/content/common/samples/ext-getuser.xml | 2 +- keystone/content/common/samples/getuser-1.json | 1 - keystone/content/common/samples/getuser-1.xml | 2 +- keystone/content/common/samples/service.xml | 2 +- keystone/content/common/samples/user.json | 4 +- keystone/content/common/samples/user.xml | 2 +- keystone/content/common/samples/validatetoken.json | 3 +- keystone/content/common/samples/validatetoken.xml | 7 +- keystone/content/service/identity.wadl | 1 + keystone/content/service/xsd/api-common.xsd | 3 +- keystone/content/service/xsd/credentials.xsd | 8 +- keystone/content/service/xsd/endpoints.xsd | 106 ++------------- keystone/content/service/xsd/extensions.xsd | 2 + keystone/content/service/xsd/fault.xsd | 2 + keystone/content/service/xsd/roles.xsd | 3 +- keystone/content/service/xsd/services.xsd | 2 + keystone/content/service/xsd/tenant.xsd | 9 +- keystone/content/service/xsd/token.xsd | 6 +- keystone/content/service/xsd/user.xsd | 2 +- 34 files changed, 317 insertions(+), 291 deletions(-) create mode 100644 keystone/content/admin/xsd/OS-KSADM-endpointtemplates.xsd diff --git a/keystone/content/admin/identity-admin-OS-KSADM.wadl b/keystone/content/admin/identity-admin-OS-KSADM.wadl index f4cb58fe..39c1c4f0 100644 --- a/keystone/content/admin/identity-admin-OS-KSADM.wadl +++ b/keystone/content/admin/identity-admin-OS-KSADM.wadl @@ -1,5 +1,5 @@ - + @@ -14,12 +14,14 @@ @@ -444,7 +446,7 @@ - + &commonFaults; diff --git a/keystone/content/admin/identity-admin.wadl b/keystone/content/admin/identity-admin.wadl index a1ee1c97..d57dbcd3 100644 --- a/keystone/content/admin/identity-admin.wadl +++ b/keystone/content/admin/identity-admin.wadl @@ -162,18 +162,19 @@

- - - + - + + + + + &commonFaults; + &getFaults; diff --git a/keystone/content/admin/xsd/OS-KSADM-endpointtemplates.xsd b/keystone/content/admin/xsd/OS-KSADM-endpointtemplates.xsd new file mode 100644 index 00000000..3ab7d4d2 --- /dev/null +++ b/keystone/content/admin/xsd/OS-KSADM-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/admin/xsd/api-common.xsd b/keystone/content/admin/xsd/api-common.xsd index 5e8ebeda..0625e5be 100644 --- a/keystone/content/admin/xsd/api-common.xsd +++ b/keystone/content/admin/xsd/api-common.xsd @@ -1,8 +1,7 @@ - - + - + - - - - + > - + - + + + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml">

- A list of credentials. + Base type for credentials in Keystone.

-
- - - - + + + - - + + + + + + + +

+ This is reserved for other credential types. +

+
+
+
+
+ +
+
- - + - - - - - + - - - - - - - - + + + + + + + - + + + + + + + +
diff --git a/keystone/content/admin/xsd/endpoints.xsd b/keystone/content/admin/xsd/endpoints.xsd index 65fc3be8..2c4336e6 100644 --- a/keystone/content/admin/xsd/endpoints.xsd +++ b/keystone/content/admin/xsd/endpoints.xsd @@ -1,6 +1,8 @@ + + - - - -

- A list of Endpoint Templates. -

-
-
-
- - - - -

- An Endpoint Template. -

-
-
-
- + + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml">

- An ID uniquely identifying the Endpoint Template. + An ID uniquely identifying the Endpoint.

- + + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml">

- The service name of Endpoint Template. + A hyperlink reference to the URL Endpoint Template.

@@ -90,8 +69,8 @@ + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml">

The region of Endpoint Template.

@@ -101,8 +80,8 @@ + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml">

The public URL to access represented service.

@@ -112,8 +91,8 @@ + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml">

The internal version of the public URL.

@@ -121,81 +100,22 @@
- - -

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

-
-
-
- -
- - - - - -

- An ID uniquely identifying the Endpoint. -

-
-
-
- - - -

- A hyperlink reference to the URL Endpoint Template. + The admin URL.

- - - - - - - - - - - + diff --git a/keystone/content/admin/xsd/extensions.xsd b/keystone/content/admin/xsd/extensions.xsd index 098d7e10..f81a04be 100644 --- a/keystone/content/admin/xsd/extensions.xsd +++ b/keystone/content/admin/xsd/extensions.xsd @@ -1,6 +1,8 @@ + + + + + + + - + @@ -59,7 +62,7 @@ - + diff --git a/keystone/content/admin/xsd/services.xsd b/keystone/content/admin/xsd/services.xsd index 1ae3a30a..b2d2dd8c 100644 --- a/keystone/content/admin/xsd/services.xsd +++ b/keystone/content/admin/xsd/services.xsd @@ -1,6 +1,8 @@ + + + @@ -53,7 +56,7 @@ - + diff --git a/keystone/content/admin/xsd/tenant.xsd b/keystone/content/admin/xsd/tenant.xsd index 3a581504..9c836ea8 100644 --- a/keystone/content/admin/xsd/tenant.xsd +++ b/keystone/content/admin/xsd/tenant.xsd @@ -1,6 +1,8 @@ + +
- +

- The name of the tenant. This is guaranteed to be unique, bit it can change. + The name of the tenant. This is guaranteed to be unique, but may change.

@@ -121,7 +123,7 @@
- + - + + + - + @@ -69,7 +71,6 @@ - diff --git a/keystone/content/admin/xsd/user.xsd b/keystone/content/admin/xsd/user.xsd index ee8d22a4..b0a1123e 100644 --- a/keystone/content/admin/xsd/user.xsd +++ b/keystone/content/admin/xsd/user.xsd @@ -1,7 +1,7 @@ - + - - - -

- An automatically generated, unique, immutable (it will never change) identifier - for the user. This is generated by the backend this user is stored in. -

-
-
-
+ + + + +

+ An automatically generated, unique, immutable (it will never change) identifier + for the user. This is generated by the backend this user is stored in. +

+
+
+
- + diff --git a/keystone/content/common/samples/auth.json b/keystone/content/common/samples/auth.json index 60d5a251..76583b02 100644 --- a/keystone/content/common/samples/auth.json +++ b/keystone/content/common/samples/auth.json @@ -14,7 +14,7 @@ "internalURL": "https://compute.north.host/v1/1234", "region": "North", "tenantId": "1234", - "versionId": "v1.0", + "versionId": "1.0", "versionInfo": "https://compute.north.host/v1.0/", "versionList": "https://compute.north.host/" }, { @@ -22,21 +22,21 @@ "internalURL": "https://compute.north.host/v1.1/3456", "region": "North", "tenantId": "3456", - "versionId": "v1.1", + "versionId": "1.1", "versionInfo": "https://compute.north.host/v1.1/", "versionList": "https://compute.north.host/" } ] }, { "name": "Cloud Files", - "type": "object store", + "type": "object-store", "endpoints": [ { "publicURL": "https://compute.north.host/v1/blah-blah", "internalURL": "https://compute.north.host/v1/blah-blah", "region": "South", "tenantId": "1234", - "versionId": "v1.0", + "versionId": "1.0", "versionInfo": "uri", "versionList": "uri" }, { @@ -44,7 +44,7 @@ "internalURL": "https://compute.north.host/v1.1/blah-blah", "region": "South", "tenantId": "3456", - "versionId": "v1.1", + "versionId": "1.1", "versionInfo": "https://compute.north.host/v1.1/", "versionList": "https://compute.north.host/" } diff --git a/keystone/content/common/samples/ext-getuser.json b/keystone/content/common/samples/ext-getuser.json index 7c068157..b1c80306 100644 --- a/keystone/content/common/samples/ext-getuser.json +++ b/keystone/content/common/samples/ext-getuser.json @@ -10,7 +10,6 @@ }, "id": "u1000", "username": "jqsmith", - "tenantId": "1234", "email": "john.smith@example.org", "enabled": true, "RS-META:metadata": { diff --git a/keystone/content/common/samples/ext-getuser.xml b/keystone/content/common/samples/ext-getuser.xml index 43e707be..b155904a 100644 --- a/keystone/content/common/samples/ext-getuser.xml +++ b/keystone/content/common/samples/ext-getuser.xml @@ -1,7 +1,7 @@ + id="u1000" username="jqsmith"> diff --git a/keystone/content/common/samples/getuser-1.json b/keystone/content/common/samples/getuser-1.json index be8ebd66..1439651d 100644 --- a/keystone/content/common/samples/getuser-1.json +++ b/keystone/content/common/samples/getuser-1.json @@ -19,7 +19,6 @@ }, "id": "u1000", "username": "jqsmith", - "tenantId": "1234", "email": "john.smith@example.org", "enabled": true } diff --git a/keystone/content/common/samples/getuser-1.xml b/keystone/content/common/samples/getuser-1.xml index 61cd862a..531a229f 100644 --- a/keystone/content/common/samples/getuser-1.xml +++ b/keystone/content/common/samples/getuser-1.xml @@ -2,7 +2,7 @@ + username="jqsmith" id="u1000"> diff --git a/keystone/content/common/samples/service.xml b/keystone/content/common/samples/service.xml index 9c6d4eab..f79a6724 100644 --- a/keystone/content/common/samples/service.xml +++ b/keystone/content/common/samples/service.xml @@ -1,4 +1,4 @@ + type="compute" description="OpenStack Compute Service" /> diff --git a/keystone/content/common/samples/user.json b/keystone/content/common/samples/user.json index 3106b4b9..1623e95d 100644 --- a/keystone/content/common/samples/user.json +++ b/keystone/content/common/samples/user.json @@ -1,7 +1,7 @@ { "user": { - "id": "jqsmith", - "tenantId": "1234", + "id": "u1000", + "username": "jqsmith", "email": "john.smith@example.org", "enabled": true } diff --git a/keystone/content/common/samples/user.xml b/keystone/content/common/samples/user.xml index fb776a6b..af035dee 100644 --- a/keystone/content/common/samples/user.xml +++ b/keystone/content/common/samples/user.xml @@ -1,5 +1,5 @@ + username="jqsmith" id="u1000"> diff --git a/keystone/content/common/samples/validatetoken.json b/keystone/content/common/samples/validatetoken.json index 3eff4601..6f655374 100644 --- a/keystone/content/common/samples/validatetoken.json +++ b/keystone/content/common/samples/validatetoken.json @@ -2,8 +2,7 @@ "auth": { "token": { "expires": "2010-11-01T03:32:15-05:00", - "id": "ab48a9efdfedb23ty3494", - "tenantId": "1234" + "id": "ab48a9efdfedb23ty3494" }, "user": { "username": "jqsmith", diff --git a/keystone/content/common/samples/validatetoken.xml b/keystone/content/common/samples/validatetoken.xml index 8e454f38..5987ff46 100644 --- a/keystone/content/common/samples/validatetoken.xml +++ b/keystone/content/common/samples/validatetoken.xml @@ -1,14 +1,13 @@ + id="ab48a9efdfedb23ty3494"/> + id="Admin" tenantId="one"/> + id="compute:cloud_admin"/> diff --git a/keystone/content/service/identity.wadl b/keystone/content/service/identity.wadl index b214e3ef..263bfe18 100644 --- a/keystone/content/service/identity.wadl +++ b/keystone/content/service/identity.wadl @@ -1,4 +1,5 @@ + diff --git a/keystone/content/service/xsd/api-common.xsd b/keystone/content/service/xsd/api-common.xsd index 5e8ebeda..0625e5be 100644 --- a/keystone/content/service/xsd/api-common.xsd +++ b/keystone/content/service/xsd/api-common.xsd @@ -1,8 +1,7 @@ - - + - + - + - +
@@ -61,7 +61,7 @@ - + diff --git a/keystone/content/service/xsd/endpoints.xsd b/keystone/content/service/xsd/endpoints.xsd index 5125483d..773e46d3 100644 --- a/keystone/content/service/xsd/endpoints.xsd +++ b/keystone/content/service/xsd/endpoints.xsd @@ -1,6 +1,8 @@ + + - - - -

- A list of Endpoint Templates. -

-
-
-
- - - - -

- An Endpoint Template. -

-
-
-
- +

- An ID uniquely identifying the Endpoint Template. + An ID uniquely identifying the Endpoint.

- +

- The service name of Endpoint Template. + A hyperlink reference to the URL Endpoint Template.

@@ -90,8 +69,8 @@ + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml">

The region of Endpoint Template.

@@ -101,8 +80,8 @@ + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml">

The public URL to access represented service.

@@ -112,8 +91,8 @@ + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml">

The internal version of the public URL.

@@ -121,77 +100,18 @@
- - -

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

-
-
-
- -
- - - - - -

- An ID uniquely identifying the Endpoint. -

-
-
-
- - - -

- A hyperlink reference to the URL Endpoint Template. + The admin URL.

- - - - - - - - - - diff --git a/keystone/content/service/xsd/extensions.xsd b/keystone/content/service/xsd/extensions.xsd index 098d7e10..f81a04be 100644 --- a/keystone/content/service/xsd/extensions.xsd +++ b/keystone/content/service/xsd/extensions.xsd @@ -1,6 +1,8 @@ + + + + + + -
\ No newline at end of file diff --git a/keystone/content/service/xsd/services.xsd b/keystone/content/service/xsd/services.xsd index e173528a..b2d2dd8c 100644 --- a/keystone/content/service/xsd/services.xsd +++ b/keystone/content/service/xsd/services.xsd @@ -1,6 +1,8 @@ + + + +

An ID uniquely identifying the tenant. This usually comes from the back-end store. + This value is guaranteed to be unique and immutable (it will never change).

- + - + - + + + - + @@ -66,7 +68,7 @@ - + diff --git a/keystone/content/service/xsd/user.xsd b/keystone/content/service/xsd/user.xsd index 1a036b1a..b0a1123e 100644 --- a/keystone/content/service/xsd/user.xsd +++ b/keystone/content/service/xsd/user.xsd @@ -1,7 +1,7 @@ - +