From db903662bf1e7c258ab3080674ee57eab6e061ab Mon Sep 17 00:00:00 2001 From: Yogeshwar Srikrishnan Date: Wed, 22 Jun 2011 23:39:46 -0500 Subject: Changes to support endpoints and endpointemplates (renaming BaseUrls and BaseURLRefs). --- doc/guide/src/docbkx/identity.wadl | 48 ++--- doc/guide/src/docbkx/identitydevguide.xml | 111 +++++++----- doc/guide/src/docbkx/samples/baseURL.json | 11 -- doc/guide/src/docbkx/samples/baseURL.xml | 12 -- doc/guide/src/docbkx/samples/baseURLRef.json | 5 - doc/guide/src/docbkx/samples/baseURLRef.xml | 4 - doc/guide/src/docbkx/samples/baseURLRefs.json | 24 --- doc/guide/src/docbkx/samples/baseURLRefs.xml | 20 -- doc/guide/src/docbkx/samples/baseURLs.json | 43 ----- doc/guide/src/docbkx/samples/baseURLs.xml | 42 ----- doc/guide/src/docbkx/samples/endpoint.json | 6 + doc/guide/src/docbkx/samples/endpoint.xml | 4 + doc/guide/src/docbkx/samples/endpointTemplate.json | 11 ++ doc/guide/src/docbkx/samples/endpointTemplate.xml | 12 ++ .../src/docbkx/samples/endpointTemplates.json | 43 +++++ doc/guide/src/docbkx/samples/endpointTemplates.xml | 42 +++++ doc/guide/src/docbkx/samples/endpoints.json | 24 +++ doc/guide/src/docbkx/samples/endpoints.xml | 20 ++ doc/guide/src/docbkx/xsd/api.xsd | 2 +- doc/guide/src/docbkx/xsd/baseURLs.xsd | 201 --------------------- doc/guide/src/docbkx/xsd/endpoints.xsd | 200 ++++++++++++++++++++ 21 files changed, 450 insertions(+), 435 deletions(-) delete mode 100644 doc/guide/src/docbkx/samples/baseURL.json delete mode 100644 doc/guide/src/docbkx/samples/baseURL.xml delete mode 100644 doc/guide/src/docbkx/samples/baseURLRef.json delete mode 100644 doc/guide/src/docbkx/samples/baseURLRef.xml delete mode 100644 doc/guide/src/docbkx/samples/baseURLRefs.json delete mode 100644 doc/guide/src/docbkx/samples/baseURLRefs.xml delete mode 100644 doc/guide/src/docbkx/samples/baseURLs.json delete mode 100644 doc/guide/src/docbkx/samples/baseURLs.xml create mode 100644 doc/guide/src/docbkx/samples/endpoint.json create mode 100644 doc/guide/src/docbkx/samples/endpoint.xml create mode 100644 doc/guide/src/docbkx/samples/endpointTemplate.json create mode 100644 doc/guide/src/docbkx/samples/endpointTemplate.xml create mode 100644 doc/guide/src/docbkx/samples/endpointTemplates.json create mode 100644 doc/guide/src/docbkx/samples/endpointTemplates.xml create mode 100644 doc/guide/src/docbkx/samples/endpoints.json create mode 100644 doc/guide/src/docbkx/samples/endpoints.xml delete mode 100755 doc/guide/src/docbkx/xsd/baseURLs.xsd create mode 100644 doc/guide/src/docbkx/xsd/endpoints.xsd diff --git a/doc/guide/src/docbkx/identity.wadl b/doc/guide/src/docbkx/identity.wadl index b153904d..ff0b2481 100644 --- a/doc/guide/src/docbkx/identity.wadl +++ b/doc/guide/src/docbkx/identity.wadl @@ -45,13 +45,13 @@ - - - - - - - + + + + + + + @@ -88,13 +88,13 @@ - + - - + + - - + + @@ -679,13 +679,13 @@ - + - + @@ -708,9 +708,9 @@ - + - + @@ -736,9 +736,9 @@ - + - + @@ -761,13 +761,13 @@ - + - + - + @@ -797,9 +797,9 @@ - + - + @@ -825,7 +825,7 @@ - + diff --git a/doc/guide/src/docbkx/identitydevguide.xml b/doc/guide/src/docbkx/identitydevguide.xml index ec23e38f..e526d23e 100755 --- a/doc/guide/src/docbkx/identitydevguide.xml +++ b/doc/guide/src/docbkx/identitydevguide.xml @@ -129,6 +129,19 @@ behave as if they are contained in that tenant. +
+ Endpoint Template + + Endpoint Template represents the templates of all the consumable services + that are available across the regions. + +
+
+ Endpoint + + Endpoint represents a service that a tenant could consume. + +
Role @@ -998,61 +1011,61 @@ Keystone will verify the token has (or belongs to a user that has) the Adm
- Endpoints (BaseURLs) + Endpoint Templates and EndPoints &LONG_URI_REFHEAD; &GET; - /baseURLs?serviceName=ServiceName + /endpointTemplates?serviceName=ServiceName - Get a list of base URLs. + Get a list of endpoint templates. &GET; - /baseURLs/enabled?serviceName=ServiceName + /endpointTemplates/enabled?serviceName=ServiceName - Get a list of enabled base URLs. + Get a list of enabled endpoint templates. &GET; - /baseURLs/baseURLId + /endpointTemplates/endpointTemplateId - Get a base URL. + Get an endpoint template. &GET; - /tenants/tenantId/baseURLRefs + /tenants/tenantId/endpoints - Get a list of base URLs for a tenant. + Get a list of endpoints for a tenant. &POST; - /tenants/tenantId/baseURLRefs + /tenants/tenantId/endpoints - Add a base URL to a tenant. + Add an endpoint to a tenant. &DELETE; - /tenants/tenantId/baseURLRefs/baseURLId + /tenants/tenantId/endpoints/endpointId - Remove Base URL from a tenant. + Remove endpoint from a tenant. @@ -1355,28 +1368,30 @@ Keystone will verify the token has (or belongs to a user that has) the Adm
- Base URLs + Endpoint Templates and Endpoints
- Get Base URLs + Get Endpoint Templates &LONG_URI_REFHEAD; &GET; - /baseURLs?serviceName=ServiceName + /endpointTemplates?serviceName=ServiceName - Get a list of base URLs. + Get a list of endpoint templates.Endpoint templates that have global set to true are + automatically available for every tenant. &GET; - /baseURLs/enabled?serviceName=ServiceName + /endpointTemplates/enabled?serviceName=ServiceName - Get a list of enabled base URLs. + Get a list of enabled endpoint templates.Endpoint templates that have global set to true are + automatically available for every tenant. @@ -1396,30 +1411,30 @@ Keystone will verify the token has (or belongs to a user that has) the Adm &NO_REQUEST; - Base URLs Response: XML + Endpoint Templates Response: XML - + - Base URLs Response: JSON + Endpoint Templates Response: JSON - +
- Get Base URL + Get Endpoint Template &LONG_URI_REFHEAD; &GET; - /baseURLs/baseURLId + /endpointTemplates/endpointTemplateId - Get a base URL. + Get an endpoint template. @@ -1438,32 +1453,32 @@ Keystone will verify the token has (or belongs to a user that has) the Adm &NO_REQUEST; - Base URL Response: XML + Endpoint Template Response: XML - + - Base URL Response: JSON + Endpoint Template Response: JSON - +
- Get Base URLs for a Tenant + Get Endpoints for a Tenant &LONG_URI_REFHEAD; &GET; - /tenants/tenantId/baseURLRefs + /tenants/tenantId/endpoints - Get a list of base URLs for a tenant. + Get a list of endpoints for a tenant. @@ -1482,30 +1497,30 @@ Keystone will verify the token has (or belongs to a user that has) the Adm &NO_REQUEST; - Base URL Refs Response: XML + Endpoints Response: XML - + - Base URL Refs Response: JSON + Endpoints Response: JSON - +
- Add Base URL to a Tenant. + Add Endpoint to a Tenant. &LONG_URI_REFHEAD; &POST; - /tenants/tenantId/baseURLRefs + /tenants/tenantId/endpoints - Add a base URL to a tenant. + Add an endpoint to a tenant. @@ -1524,34 +1539,34 @@ Keystone will verify the token has (or belongs to a user that has) the Adm serviceUnavailable (503) - Expect a badRequest (400) response if a disabled base URL is added or if the base URL had been previously added. + Expect a badRequest (400) response if a disabled endpoint is added or if the endpoint had been previously added. - Add Base URL Request: XML + Add Endpoint Request: XML - + - Add Base URL Request: JSON + Add Endpoint Request: JSON - +
- Remove Base URLs from a Tennat + Remove Endpoints from a Tenant &LONG_URI_REFHEAD; &DELETE; - /tenant/tenantId/baseURLRefs/baseURLRefId + /tenants/tenantId/endpoints/endpointId - Remove Base URL from a tenant. + Remove endpoint from a tenant. diff --git a/doc/guide/src/docbkx/samples/baseURL.json b/doc/guide/src/docbkx/samples/baseURL.json deleted file mode 100644 index 3c15aafe..00000000 --- a/doc/guide/src/docbkx/samples/baseURL.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "baseURL":{ - "id":1, - "region":"DFW", - "default":true, - "serviceName":"service1", - "publicURL":"https://service-public.com/v1", - "internalURL":"https://service-internal.com/v1", - "enabled":true - } -} diff --git a/doc/guide/src/docbkx/samples/baseURL.xml b/doc/guide/src/docbkx/samples/baseURL.xml deleted file mode 100644 index a66d5516..00000000 --- a/doc/guide/src/docbkx/samples/baseURL.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - diff --git a/doc/guide/src/docbkx/samples/baseURLRef.json b/doc/guide/src/docbkx/samples/baseURLRef.json deleted file mode 100644 index 13e8c9dc..00000000 --- a/doc/guide/src/docbkx/samples/baseURLRef.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "baseURLRef":{ - "id":3 - } -} diff --git a/doc/guide/src/docbkx/samples/baseURLRef.xml b/doc/guide/src/docbkx/samples/baseURLRef.xml deleted file mode 100644 index 16c71870..00000000 --- a/doc/guide/src/docbkx/samples/baseURLRef.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - diff --git a/doc/guide/src/docbkx/samples/baseURLRefs.json b/doc/guide/src/docbkx/samples/baseURLRefs.json deleted file mode 100644 index 6f0fd41e..00000000 --- a/doc/guide/src/docbkx/samples/baseURLRefs.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "baseURLRefs":[ - { - "id":1, - "href":"https://auth.keystone.com/v2.0/baseURLs/1" - }, - { - "id":2, - "href":"https://auth.keystone.com/v2.0/baseURLs/2" - }, - { - "id":3, - "href":"https://auth.keystone.com/v2.0/baseURLs/3" - }, - { - "id":4, - "href":"https://auth.keystone.com/v2.0/baseURLs/4" - }, - { - "id":5, - "href":"https://auth.keystone.com/v2.0/baseURLs/5" - } - ] -} diff --git a/doc/guide/src/docbkx/samples/baseURLRefs.xml b/doc/guide/src/docbkx/samples/baseURLRefs.xml deleted file mode 100644 index 0c095626..00000000 --- a/doc/guide/src/docbkx/samples/baseURLRefs.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - - - - diff --git a/doc/guide/src/docbkx/samples/baseURLs.json b/doc/guide/src/docbkx/samples/baseURLs.json deleted file mode 100644 index 0c3a9938..00000000 --- a/doc/guide/src/docbkx/samples/baseURLs.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "baseURLs":[ - { - "id":1, - "region":"DFW", - "default":true, - "serviceName":"service1", - "publicURL":"https://service1.public.com/v1", - "internalURL":"https://service1.internal.com/v1", - "enabled":true - }, - { - "id":2, - "region":"ORD", - "serviceName":"service2", - "publicURL":"https://service2.public.com/v1", - "internalURL":"https://service2.internal.com/v1", - "enabled":false - }, - { - "id":3, - "region":"DFW", - "default":true, - "serviceName":"service1", - "publicURL":"https://service.public.com/v1.0", - "enabled":true - }, - { - "id":4, - "region":"ORD", - "serviceName":"service2", - "publicURL":"https://service2.public.com/v2", - "enabled":true - }, - { - "id":5, - "default":true, - "serviceName":"service3", - "publicURL":"https://service3.public.com/v3.2", - "enabled":true - } - ] -} diff --git a/doc/guide/src/docbkx/samples/baseURLs.xml b/doc/guide/src/docbkx/samples/baseURLs.xml deleted file mode 100644 index 9f829e9d..00000000 --- a/doc/guide/src/docbkx/samples/baseURLs.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - - diff --git a/doc/guide/src/docbkx/samples/endpoint.json b/doc/guide/src/docbkx/samples/endpoint.json new file mode 100644 index 00000000..8ca1f099 --- /dev/null +++ b/doc/guide/src/docbkx/samples/endpoint.json @@ -0,0 +1,6 @@ +{ + "endpoint":{ + "id":3, + "href":"https://auth.keystone.com/v2.0/baseURLs/1" + } +} diff --git a/doc/guide/src/docbkx/samples/endpoint.xml b/doc/guide/src/docbkx/samples/endpoint.xml new file mode 100644 index 00000000..8ff1e48c --- /dev/null +++ b/doc/guide/src/docbkx/samples/endpoint.xml @@ -0,0 +1,4 @@ + + + diff --git a/doc/guide/src/docbkx/samples/endpointTemplate.json b/doc/guide/src/docbkx/samples/endpointTemplate.json new file mode 100644 index 00000000..2ed4917f --- /dev/null +++ b/doc/guide/src/docbkx/samples/endpointTemplate.json @@ -0,0 +1,11 @@ +{ + "endpointTemplate":{ + "id":1, + "region":"DFW", + "global":true, + "serviceName":"service1", + "publicURL":"https://service-public.com/v1", + "internalURL":"https://service-internal.com/v1", + "enabled":true + } +} diff --git a/doc/guide/src/docbkx/samples/endpointTemplate.xml b/doc/guide/src/docbkx/samples/endpointTemplate.xml new file mode 100644 index 00000000..31f4eaeb --- /dev/null +++ b/doc/guide/src/docbkx/samples/endpointTemplate.xml @@ -0,0 +1,12 @@ + + + diff --git a/doc/guide/src/docbkx/samples/endpointTemplates.json b/doc/guide/src/docbkx/samples/endpointTemplates.json new file mode 100644 index 00000000..488e8c5d --- /dev/null +++ b/doc/guide/src/docbkx/samples/endpointTemplates.json @@ -0,0 +1,43 @@ +{ + "endpointsTemplates":[ + { + "id":1, + "region":"DFW", + "global":true, + "serviceName":"service1", + "publicURL":"https://service1.public.com/v1", + "internalURL":"https://service1.internal.com/v1", + "enabled":true + }, + { + "id":2, + "region":"ORD", + "serviceName":"service2", + "publicURL":"https://service2.public.com/v1", + "internalURL":"https://service2.internal.com/v1", + "enabled":false + }, + { + "id":3, + "region":"DFW", + "global":true, + "serviceName":"service1", + "publicURL":"https://service.public.com/v1.0", + "enabled":true + }, + { + "id":4, + "region":"ORD", + "serviceName":"service2", + "publicURL":"https://service2.public.com/v2", + "enabled":true + }, + { + "id":5, + "global":true, + "serviceName":"service3", + "publicURL":"https://service3.public.com/v3.2", + "enabled":true + } + ] +} diff --git a/doc/guide/src/docbkx/samples/endpointTemplates.xml b/doc/guide/src/docbkx/samples/endpointTemplates.xml new file mode 100644 index 00000000..60a9d2e4 --- /dev/null +++ b/doc/guide/src/docbkx/samples/endpointTemplates.xml @@ -0,0 +1,42 @@ + + + + + + + + + diff --git a/doc/guide/src/docbkx/samples/endpoints.json b/doc/guide/src/docbkx/samples/endpoints.json new file mode 100644 index 00000000..f8c79aa2 --- /dev/null +++ b/doc/guide/src/docbkx/samples/endpoints.json @@ -0,0 +1,24 @@ +{ + "endpoints":[ + { + "id":1, + "href":"https://auth.keystone.com/v2.0/baseURLs/1" + }, + { + "id":2, + "href":"https://auth.keystone.com/v2.0/baseURLs/2" + }, + { + "id":3, + "href":"https://auth.keystone.com/v2.0/baseURLs/3" + }, + { + "id":4, + "href":"https://auth.keystone.com/v2.0/baseURLs/4" + }, + { + "id":5, + "href":"https://auth.keystone.com/v2.0/baseURLs/5" + } + ] +} diff --git a/doc/guide/src/docbkx/samples/endpoints.xml b/doc/guide/src/docbkx/samples/endpoints.xml new file mode 100644 index 00000000..3fa46c4c --- /dev/null +++ b/doc/guide/src/docbkx/samples/endpoints.xml @@ -0,0 +1,20 @@ + + + + + + + + + diff --git a/doc/guide/src/docbkx/xsd/api.xsd b/doc/guide/src/docbkx/xsd/api.xsd index ebb1ca3b..14d3ae8e 100755 --- a/doc/guide/src/docbkx/xsd/api.xsd +++ b/doc/guide/src/docbkx/xsd/api.xsd @@ -11,7 +11,7 @@ - + diff --git a/doc/guide/src/docbkx/xsd/baseURLs.xsd b/doc/guide/src/docbkx/xsd/baseURLs.xsd deleted file mode 100755 index e1d63887..00000000 --- a/doc/guide/src/docbkx/xsd/baseURLs.xsd +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - - - - -

- A list of base URLs. -

- - - - - - - -

- A base URLs. -

- - - - - - -

- A refrence to a base URL. -

- - - - - - -

- A list of base URL refrences. -

- - - - - - - - - -

- An ID uniquely identifying the base URL. -

- - - - - - -

- The base URL's service name. -

- - - - - - -

- The URL's region. -

- - - - - - -

- The public base URL. -

- - - - - - -

- The internal version of the public base URL. -

- - - - - - -

- The admin base URL. -

- - - - - - -

- If true the baseURL is automatically added to - new accounts. -

- - - - - - -

- True if the Base URL is enabled (active). - A Base URL cannot be added if it's disabled or inactive (false). -

- - - - - - - - - - -

- An ID uniquely identifying the base URL. -

- - - - - - -

- A hyperlink reference to the base URL. -

- - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/guide/src/docbkx/xsd/endpoints.xsd b/doc/guide/src/docbkx/xsd/endpoints.xsd new file mode 100644 index 00000000..7044e173 --- /dev/null +++ b/doc/guide/src/docbkx/xsd/endpoints.xsd @@ -0,0 +1,200 @@ + + + + + + + + + +

+ A list of Endpoint Templates. +

+ + + + + + + +

+ An Endpoint Template. +

+ + + + + + +

+ An Endpoint. +

+ + + + + + +

+ A list of Endpoints. +

+ + + + + + + + + +

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

+ + + + + + + + + + +

+ An ID uniquely identifying the Endpoint. +

+ + + + + + +

+ A hyperlink reference to the URL Endpoint Template. +

+ + + + + + + + + + + + + + + + + + + + + + + + -- cgit