summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZiad Sawalha <ziad.sawalha@rackspace.com>2011-06-22 21:53:24 -0700
committerZiad Sawalha <ziad.sawalha@rackspace.com>2011-06-22 21:53:24 -0700
commite482fc5c06cc2dfeb6663bb63c76dd2cfb523993 (patch)
tree44974834f5515a99eab1b75b565d357ddcedb21e
parentea31dfc53ff9822da79e5ab6ac7f11a3c2b7fe5e (diff)
parent6ace32ebc86aa619c9f9540d140aa1587ebf9705 (diff)
downloadkeystone-e482fc5c06cc2dfeb6663bb63c76dd2cfb523993.tar.gz
keystone-e482fc5c06cc2dfeb6663bb63c76dd2cfb523993.tar.xz
keystone-e482fc5c06cc2dfeb6663bb63c76dd2cfb523993.zip
Merge pull request #64 from yogirackspace/master
DocBook changes to support endpoints and endpointtemplates.
-rw-r--r--doc/guide/src/docbkx/identity.wadl48
-rwxr-xr-xdoc/guide/src/docbkx/identitydevguide.xml111
-rw-r--r--doc/guide/src/docbkx/samples/baseURLRef.json5
-rw-r--r--doc/guide/src/docbkx/samples/baseURLRef.xml4
-rw-r--r--doc/guide/src/docbkx/samples/endpoint.json6
-rw-r--r--doc/guide/src/docbkx/samples/endpoint.xml4
-rw-r--r--doc/guide/src/docbkx/samples/endpointTemplate.json (renamed from doc/guide/src/docbkx/samples/baseURL.json)4
-rw-r--r--doc/guide/src/docbkx/samples/endpointTemplate.xml (renamed from doc/guide/src/docbkx/samples/baseURL.xml)4
-rw-r--r--doc/guide/src/docbkx/samples/endpointTemplates.json (renamed from doc/guide/src/docbkx/samples/baseURLs.json)8
-rw-r--r--doc/guide/src/docbkx/samples/endpointTemplates.xml (renamed from doc/guide/src/docbkx/samples/baseURLs.xml)20
-rw-r--r--doc/guide/src/docbkx/samples/endpoints.json (renamed from doc/guide/src/docbkx/samples/baseURLRefs.json)2
-rw-r--r--doc/guide/src/docbkx/samples/endpoints.xml (renamed from doc/guide/src/docbkx/samples/baseURLRefs.xml)14
-rwxr-xr-xdoc/guide/src/docbkx/xsd/api.xsd2
-rw-r--r--[-rwxr-xr-x]doc/guide/src/docbkx/xsd/endpoints.xsd (renamed from doc/guide/src/docbkx/xsd/baseURLs.xsd)53
14 files changed, 150 insertions, 135 deletions
diff --git a/doc/guide/src/docbkx/identity.wadl b/doc/guide/src/docbkx/identity.wadl
index 2d1755ee..18d6e872 100644
--- a/doc/guide/src/docbkx/identity.wadl
+++ b/doc/guide/src/docbkx/identity.wadl
@@ -45,13 +45,13 @@
<method href="#getTenant" />
<method href="#updateTenant" />
<method href="#deleteTenant" />
- <resource id="baseURLRefs" path="baseURLRefs">
- <method href="#getBaseURLRefs"/>
- <method href="#addBaseURLRef"/>
- <resource id="baseURLRef" path="{baseURLId}">
- <param name="baseURLId" style="template" type="xsd:int"/>
- <method href="#getBaseURLRef"/>
- <method href="#deleteBaseURLRef"/>
+ <resource id="endpoints" path="endpoints">
+ <method href="#getEndpoints"/>
+ <method href="#addEndpoint"/>
+ <resource id="endpoint" path="{endpointId}">
+ <param name="endpointId" style="template" type="xsd:int"/>
+ <method href="#getEndpoint"/>
+ <method href="#deleteEndpoint"/>
</resource>
</resource>
<resource id="roleRefs" path="roleRefs">
@@ -88,13 +88,13 @@
</resource>
</resource>
- <resource id="baseURLs" path="baseURLs">
+ <resource id="endpointTemplates" path="endpointTemplates">
<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
- <method href="#getBaseURLs"/>
- <resource id="baseURLId" path="{baseURLId}">
+ <method href="#getEndpointTemplates"/>
+ <resource id="endpointTemplateId" path="{endpointTemplateId}">
<param name="X-Auth-Token" style="header" type="xsd:string" required="true"/>
- <param name="baseURLId" style="template" type="xsd:int"/>
- <method href="#getBaseURL"/>
+ <param name="endpointTemplateId" style="template" type="xsd:int"/>
+ <method href="#getEndpointTemplate"/>
</resource>
</resource>
@@ -679,13 +679,13 @@
</response>
</method>
- <method name="GET" id="getBaseURLs">
+ <method name="GET" id="getEndpointTemplates">
<request>
<param name="serviceName" style="query"
required="false" type="xsd:string"/>
</request>
<response status="200 203">
- <representation mediaType="application/xml" element="identity:baseURLs"/>
+ <representation mediaType="application/xml" element="identity:endpointTemplates"/>
<representation mediaType="application/json"/>
</response>
<response status="400">
@@ -708,9 +708,9 @@
</response>
</method>
- <method name="GET" id="getBaseURL">
+ <method name="GET" id="getEndpointTemplate">
<response status="200 203">
- <representation mediaType="application/xml" element="identity:baseURL"/>
+ <representation mediaType="application/xml" element="identity:endpointTemplate"/>
<representation mediaType="application/json"/>
</response>
<response status="400">
@@ -736,9 +736,9 @@
</response>
</method>
- <method name="GET" id="getBaseURLRefs">
+ <method name="GET" id="getEndpoints">
<response status="200 203">
- <representation mediaType="application/xml" element="identity:baseURLRefs"/>
+ <representation mediaType="application/xml" element="identity:endpoints"/>
<representation mediaType="application/json"/>
</response>
<response status="400">
@@ -761,13 +761,13 @@
</response>
</method>
- <method name="POST" id="addBaseURLRef">
+ <method name="POST" id="addEndpoint">
<request>
- <representation mediaType="application/xml" element="identity:baseURLRef"/>
+ <representation mediaType="application/xml" element="identity:endpoint"/>
<representation mediaType="application/json"/>
</request>
<response status="201">
- <representation mediaType="application/xml" element="identity:baseURLRef">
+ <representation mediaType="application/xml" element="identity:endpoint">
<param name="Location" type="xsd:anyURI" style="header"/>
</representation>
<representation mediaType="application/json">
@@ -797,9 +797,9 @@
</response>
</method>
- <method name="GET" id="getBaseURLRef">
+ <method name="GET" id="getEndpoint">
<response status="200 203">
- <representation mediaType="application/xml" element="identity:baseURLRef"/>
+ <representation mediaType="application/xml" element="identity:endpoint"/>
<representation mediaType="application/json"/>
</response>
<response status="400">
@@ -825,7 +825,7 @@
</response>
</method>
- <method name="DELETE" id="deleteBaseURLRef">
+ <method name="DELETE" id="deleteEndpoint">
<response status="204"/>
<response status="400">
<representation mediaType="application/xml" element="identity:badRequest"/>
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
@@ -130,6 +130,19 @@
</para>
</section>
<section>
+ <title>Endpoint Template</title>
+ <para>
+ Endpoint Template represents the templates of all the consumable services
+ that are available across the regions.
+ </para>
+ </section>
+ <section>
+ <title>Endpoint</title>
+ <para>
+ Endpoint represents a service that a tenant could consume.
+ </para>
+ </section>
+ <section>
<title>Role</title>
<para>
A role that an identity is associated with that allows it
@@ -998,61 +1011,61 @@ Keystone will verify the token has (or belongs to a user that has) the <code>Adm
</section>
<section>
- <title>Endpoints (BaseURLs)</title>
+ <title>Endpoint Templates and EndPoints</title>
<informaltable rules="all">
&LONG_URI_REFHEAD;
<tbody>
<tr>
<td colspan="1">&GET;
</td>
- <td colspan="4">/baseURLs?<parameter>serviceName</parameter>=<literal>ServiceName</literal>
+ <td colspan="4">/endpointTemplates?<parameter>serviceName</parameter>=<literal>ServiceName</literal>
</td>
<td colspan="3">
- Get a list of base URLs.
+ Get a list of endpoint templates.
</td>
</tr>
<tr>
<td colspan="1">&GET;
</td>
- <td colspan="4">/baseURLs/enabled?<parameter>serviceName</parameter>=<literal>ServiceName</literal>
+ <td colspan="4">/endpointTemplates/enabled?<parameter>serviceName</parameter>=<literal>ServiceName</literal>
</td>
<td colspan="3">
- Get a list of enabled base URLs.
+ Get a list of enabled endpoint templates.
</td>
</tr>
<tr>
<td colspan="1">&GET;
</td>
- <td colspan="4">/baseURLs/<parameter>baseURLId</parameter>
+ <td colspan="4">/endpointTemplates/<parameter>endpointTemplateId</parameter>
</td>
<td colspan="3">
- Get a base URL.
+ Get an endpoint template.
</td>
</tr>
<tr>
<td colspan="1">&GET;
</td>
- <td colspan="4">/tenants/<parameter>tenantId</parameter>/baseURLRefs
+ <td colspan="4">/tenants/<parameter>tenantId</parameter>/endpoints
</td>
<td colspan="3">
- Get a list of base URLs for a tenant.
+ Get a list of endpoints for a tenant.
</td>
</tr>
<tr>
<td colspan="1">&POST;
</td>
- <td colspan="4">/tenants/<parameter>tenantId</parameter>/baseURLRefs
+ <td colspan="4">/tenants/<parameter>tenantId</parameter>/endpoints
</td>
<td colspan="3">
- Add a base URL to a tenant.
+ Add an endpoint to a tenant.
</td>
</tr>
<tr>
<td colspan="1">&DELETE;
</td>
- <td colspan="4">/tenants/<parameter>tenantId</parameter>/baseURLRefs/<parameter>baseURLId</parameter></td>
+ <td colspan="4">/tenants/<parameter>tenantId</parameter>/endpoints/<parameter>endpointId</parameter></td>
<td colspan="3">
- Remove Base URL from a tenant.
+ Remove endpoint from a tenant.
</td>
</tr>
</tbody>
@@ -1355,28 +1368,30 @@ Keystone will verify the token has (or belongs to a user that has) the <code>Adm
</section>
</section>
<section>
- <title>Base URLs</title>
+ <title>Endpoint Templates and Endpoints</title>
<section>
- <title>Get Base URLs</title>
+ <title>Get Endpoint Templates</title>
<informaltable rules="all">
&LONG_URI_REFHEAD;
<tbody>
<tr>
<td colspan="1">&GET;
</td>
- <td colspan="4">/baseURLs?<parameter>serviceName</parameter>=<literal>ServiceName</literal>
+ <td colspan="4">/endpointTemplates?<parameter>serviceName</parameter>=<literal>ServiceName</literal>
</td>
<td colspan="3">
- 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.
</td>
</tr>
<tr>
<td colspan="1">&GET;
</td>
- <td colspan="4">/baseURLs/enabled?<parameter>serviceName</parameter>=<literal>ServiceName</literal>
+ <td colspan="4">/endpointTemplates/enabled?<parameter>serviceName</parameter>=<literal>ServiceName</literal>
</td>
<td colspan="3">
- 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.
</td>
</tr>
@@ -1396,30 +1411,30 @@ Keystone will verify the token has (or belongs to a user that has) the <code>Adm
</simpara>
&NO_REQUEST;
<example>
- <title>Base URLs Response: XML</title>
+ <title>Endpoint Templates Response: XML</title>
<programlisting language="xml">
-<xi:include href="samples/baseURLs.xml" parse="text"/>
+<xi:include href="samples/endpointTemplates.xml" parse="text"/>
</programlisting>
</example>
<example>
- <title>Base URLs Response: JSON</title>
+ <title>Endpoint Templates Response: JSON</title>
<programlisting language="javascript">
-<xi:include href="samples/baseURLs.json" parse="text"/>
+<xi:include href="samples/endpointTemplates.json" parse="text"/>
</programlisting>
</example>
</section>
<section>
- <title>Get Base URL</title>
+ <title>Get Endpoint Template</title>
<informaltable rules="all">
&LONG_URI_REFHEAD;
<tbody>
<tr>
<td colspan="1">&GET;
</td>
- <td colspan="4">/baseURLs/<parameter>baseURLId</parameter>
+ <td colspan="4">/endpointTemplates/<parameter>endpointTemplateId</parameter>
</td>
<td colspan="3">
- Get a base URL.
+ Get an endpoint template.
</td>
</tr>
</tbody>
@@ -1438,32 +1453,32 @@ Keystone will verify the token has (or belongs to a user that has) the <code>Adm
</simpara>
&NO_REQUEST;
<example>
- <title>Base URL Response: XML</title>
+ <title>Endpoint Template Response: XML</title>
<?dbfo keep-together="always"?>
<programlisting language="xml">
-<xi:include href="samples/baseURL.xml" parse="text"/>
+<xi:include href="samples/endpointTemplate.xml" parse="text"/>
</programlisting>
</example>
<example>
- <title>Base URL Response: JSON</title>
+ <title>Endpoint Template Response: JSON</title>
<?dbfo keep-together="always"?>
<programlisting language="javascript">
-<xi:include href="samples/baseURL.json" parse="text"/>
+<xi:include href="samples/endpointTemplate.json" parse="text"/>
</programlisting>
</example>
</section>
<section>
- <title>Get Base URLs for a Tenant</title>
+ <title>Get Endpoints for a Tenant</title>
<informaltable rules="all">
&LONG_URI_REFHEAD;
<tbody>
<tr>
<td colspan="1">&GET;
</td>
- <td colspan="4">/tenants/<parameter>tenantId</parameter>/baseURLRefs
+ <td colspan="4">/tenants/<parameter>tenantId</parameter>/endpoints
</td>
<td colspan="3">
- Get a list of base URLs for a tenant.
+ Get a list of endpoints for a tenant.
</td>
</tr>
</tbody>
@@ -1482,30 +1497,30 @@ Keystone will verify the token has (or belongs to a user that has) the <code>Adm
</simpara>
&NO_REQUEST;
<example>
- <title>Base URL Refs Response: XML</title>
+ <title>Endpoints Response: XML</title>
<programlisting language="xml">
-<xi:include href="samples/baseURLRefs.xml" parse="text"/>
+<xi:include href="samples/endpoints.xml" parse="text"/>
</programlisting>
</example>
<example>
- <title>Base URL Refs Response: JSON</title>
+ <title>Endpoints Response: JSON</title>
<programlisting language="javascript">
-<xi:include href="samples/baseURLRefs.json" parse="text"/>
+<xi:include href="samples/endpoints.json" parse="text"/>
</programlisting>
</example>
</section>
<section>
- <title>Add Base URL to a Tenant.</title>
+ <title>Add Endpoint to a Tenant.</title>
<informaltable rules="all">
&LONG_URI_REFHEAD;
<tbody>
<tr>
<td colspan="1">&POST;
</td>
- <td colspan="4">/tenants/<parameter>tenantId</parameter>/baseURLRefs
+ <td colspan="4">/tenants/<parameter>tenantId</parameter>/endpoints
</td>
<td colspan="3">
- Add a base URL to a tenant.
+ Add an endpoint to a tenant.
</td>
</tr>
</tbody>
@@ -1524,34 +1539,34 @@ Keystone will verify the token has (or belongs to a user that has) the <code>Adm
serviceUnavailable (<errorcode>503</errorcode>)
</simpara>
<para xmlns="http://docbook.org/ns/docbook">
- 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.
</para>
<example>
- <title>Add Base URL Request: XML</title>
+ <title>Add Endpoint Request: XML</title>
<?dbfo keep-together="always"?>
<programlisting language="xml">
-<xi:include href="samples/baseURL.xml" parse="text"/>
+<xi:include href="samples/endpoint.xml" parse="text"/>
</programlisting>
</example>
<example>
- <title>Add Base URL Request: JSON</title>
+ <title>Add Endpoint Request: JSON</title>
<?dbfo keep-together="always"?>
<programlisting language="javascript">
-<xi:include href="samples/baseURL.json" parse="text"/>
+<xi:include href="samples/endpoint.json" parse="text"/>
</programlisting>
</example>
</section>
<section>
- <title>Remove Base URLs from a Tennat</title>
+ <title>Remove Endpoints from a Tenant</title>
<informaltable rules="all">
&LONG_URI_REFHEAD;
<tbody>
<tr>
<td colspan="1">&DELETE;
</td>
- <td colspan="4">/tenant/<parameter>tenantId</parameter>/baseURLRefs/<parameter>baseURLRefId</parameter></td>
+ <td colspan="4">/tenants/<parameter>tenantId</parameter>/endpoints/<parameter>endpointId</parameter></td>
<td colspan="3">
- Remove Base URL from a tenant.
+ Remove endpoint from a tenant.
</td>
</tr>
</tbody>
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 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<baseURLRef xmlns="http://docs.openstack.org/identity/api/v2.0"
- id="3" />
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 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<endpoint xmlns="http://docs.openstack.org/identity/api/v2.0"
+ id="3" />
diff --git a/doc/guide/src/docbkx/samples/baseURL.json b/doc/guide/src/docbkx/samples/endpointTemplate.json
index 3c15aafe..2ed4917f 100644
--- a/doc/guide/src/docbkx/samples/baseURL.json
+++ b/doc/guide/src/docbkx/samples/endpointTemplate.json
@@ -1,8 +1,8 @@
{
- "baseURL":{
+ "endpointTemplate":{
"id":1,
"region":"DFW",
- "default":true,
+ "global":true,
"serviceName":"service1",
"publicURL":"https://service-public.com/v1",
"internalURL":"https://service-internal.com/v1",
diff --git a/doc/guide/src/docbkx/samples/baseURL.xml b/doc/guide/src/docbkx/samples/endpointTemplate.xml
index a66d5516..31f4eaeb 100644
--- a/doc/guide/src/docbkx/samples/baseURL.xml
+++ b/doc/guide/src/docbkx/samples/endpointTemplate.xml
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
-<baseURL
+<endpointTemplate
xmlns="http://docs.openstack.org/identity/api/v2.0"
id="1"
region="DFW"
- default="true"
+ global="true"
serviceName="service1"
publicURL="https://service-public.com/v1"
internalURL="https://service-internal.com/v1"
diff --git a/doc/guide/src/docbkx/samples/baseURLs.json b/doc/guide/src/docbkx/samples/endpointTemplates.json
index 0c3a9938..488e8c5d 100644
--- a/doc/guide/src/docbkx/samples/baseURLs.json
+++ b/doc/guide/src/docbkx/samples/endpointTemplates.json
@@ -1,9 +1,9 @@
{
- "baseURLs":[
+ "endpointsTemplates":[
{
"id":1,
"region":"DFW",
- "default":true,
+ "global":true,
"serviceName":"service1",
"publicURL":"https://service1.public.com/v1",
"internalURL":"https://service1.internal.com/v1",
@@ -20,7 +20,7 @@
{
"id":3,
"region":"DFW",
- "default":true,
+ "global":true,
"serviceName":"service1",
"publicURL":"https://service.public.com/v1.0",
"enabled":true
@@ -34,7 +34,7 @@
},
{
"id":5,
- "default":true,
+ "global":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/endpointTemplates.xml
index 9f829e9d..60a9d2e4 100644
--- a/doc/guide/src/docbkx/samples/baseURLs.xml
+++ b/doc/guide/src/docbkx/samples/endpointTemplates.xml
@@ -1,16 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
-<baseURLs xmlns="http://docs.openstack.org/identity/api/v2.0">
- <baseURL
+<endpointTemplates xmlns="http://docs.openstack.org/identity/api/v2.0">
+ <endpointTemplate
id="1"
region="DFW"
- default="true"
+ global="true"
serviceName="service1"
publicURL="https://service1.public.com/v1"
internalURL="https://service1.internal.clouddrive.com/v1"
enabled="true"
/>
- <baseURL
+ <endpointTemplate
id="2"
region="ORD"
serviceName="service2"
@@ -18,25 +18,25 @@
internalURL="https://service2.internal.public.com/v1"
enabled="false"
/>
- <baseURL
+ <endpointTemplate
id="3"
region="DFW"
- default="true"
+ global="true"
serviceName="service1"
publicURL="https://service1.public.com/v1"
enabled="true"
/>
- <baseURL
+ <endpointTemplate
id="4"
region="ORD"
serviceName="service2"
publicURL="https://service2.public.com/v1"
enabled="true"
/>
- <baseURL
+ <endpointTemplate
id="5"
- default="true"
+ global="true"
serviceName="service3"
publicURL="https://service3.public.com/v1"
/>
-</baseURLs>
+</endpointTemplates>
diff --git a/doc/guide/src/docbkx/samples/baseURLRefs.json b/doc/guide/src/docbkx/samples/endpoints.json
index 6f0fd41e..f8c79aa2 100644
--- a/doc/guide/src/docbkx/samples/baseURLRefs.json
+++ b/doc/guide/src/docbkx/samples/endpoints.json
@@ -1,5 +1,5 @@
{
- "baseURLRefs":[
+ "endpoints":[
{
"id":1,
"href":"https://auth.keystone.com/v2.0/baseURLs/1"
diff --git a/doc/guide/src/docbkx/samples/baseURLRefs.xml b/doc/guide/src/docbkx/samples/endpoints.xml
index 0c095626..3fa46c4c 100644
--- a/doc/guide/src/docbkx/samples/baseURLRefs.xml
+++ b/doc/guide/src/docbkx/samples/endpoints.xml
@@ -1,20 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
-<baseURLRefs
+<endpoints
xmlns="http://docs.openstack.org/identity/api/v2.0">
- <baseURLRef
+ <endpoint
href="https://auth.keystone.com/v2.0/baseURLs/1"
id="1" />
- <baseURLRef
+ <endpoint
href="https://auth.keystone.com/v2.0/baseURLs/2"
id="2" />
- <baseURLRef
+ <endpoint
href="https://auth.keystone.com/v2.0/baseURLs/3"
id="3" />
- <baseURLRef
+ <endpoint
href="https://auth.keystone.com/v2.0/baseURLs/4"
id="4" />
- <baseURLRef
+ <endpoint
href="https://auth.keystone.com/v2.0/baseURLs/5"
id="5" />
-</baseURLRefs>
+</endpoints>
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 @@
<include schemaLocation="token.xsd"/>
<include schemaLocation="tenant.xsd"/>
<include schemaLocation="fault.xsd"/>
- <include schemaLocation="baseURLs.xsd"/>
+ <include schemaLocation="endpoints.xsd"/>
<include schemaLocation="roles.xsd"/>
<include schemaLocation="user.xsd"/>
</schema>
diff --git a/doc/guide/src/docbkx/xsd/baseURLs.xsd b/doc/guide/src/docbkx/xsd/endpoints.xsd
index e1d63887..7044e173 100755..100644
--- a/doc/guide/src/docbkx/xsd/baseURLs.xsd
+++ b/doc/guide/src/docbkx/xsd/endpoints.xsd
@@ -14,61 +14,61 @@
<import vc:minVersion="1.1" namespace="http://www.w3.org/2005/Atom"
schemaLocation="atom/atom.xsd" />
- <element name="baseURLs" type="idm:BaseURLList">
+ <element name="endpointTemplates" type="idm:EndpointTemplateList">
<annotation>
<xsd:documentation
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- A list of base URLs.
+ A list of Endpoint Templates.
</p>
</xsd:documentation>
</annotation>
</element>
- <element name="baseURL" type="idm:BaseURL">
+ <element name="endpointTemplate" type="idm:EndpointTemplate">
<annotation>
<xsd:documentation
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- A base URLs.
+ An Endpoint Template.
</p>
</xsd:documentation>
</annotation>
</element>
- <element name="baseURLRef" type="idm:BaseURLRef">
+ <element name="endpoint" type="idm:Endpoint">
<annotation>
<xsd:documentation
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- A refrence to a base URL.
+ An Endpoint.
</p>
</xsd:documentation>
</annotation>
</element>
- <element name="baseURLRefs" type="idm:BaseURLRefList">
+ <element name="endpoints" type="idm:EndpointList">
<annotation>
<xsd:documentation
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- A list of base URL refrences.
+ A list of Endpoints.
</p>
</xsd:documentation>
</annotation>
</element>
<!-- Complex Types -->
- <complexType name="BaseURL">
+ <complexType name="EndpointTemplate">
<attribute name="id" type="xsd:int" use="required">
<annotation>
<xsd:documentation
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- An ID uniquely identifying the base URL.
+ An ID uniquely identifying the Endpoint Template.
</p>
</xsd:documentation>
</annotation>
@@ -79,7 +79,7 @@
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- The base URL's service name.
+ The service name of Endpoint Template.
</p>
</xsd:documentation>
</annotation>
@@ -90,7 +90,7 @@
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- The URL's region.
+ The region of Endpoint Template.
</p>
</xsd:documentation>
</annotation>
@@ -101,7 +101,7 @@
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- The public base URL.
+ The public URL to access represented service.
</p>
</xsd:documentation>
</annotation>
@@ -112,7 +112,7 @@
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- The internal version of the public base URL.
+ The internal version of the public URL.
</p>
</xsd:documentation>
</annotation>
@@ -123,19 +123,18 @@
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- The admin base URL.
+ The admin URL.
</p>
</xsd:documentation>
</annotation>
</attribute>
- <attribute name="default" type="xsd:boolean" default="false" use="optional">
+ <attribute name="global" type="xsd:boolean" default="false" use="optional">
<annotation>
<xsd:documentation
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- If true the baseURL is automatically added to
- new accounts.
+ If true the Endpoint Template is automatically part of every account.
</p>
</xsd:documentation>
</annotation>
@@ -146,8 +145,8 @@
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- True if the Base URL is enabled (active).
- A Base URL cannot be added if it's disabled or inactive (false).
+ True if the Endpoint Template is enabled (active).
+ A Endpoint Template cannot be added if it's disabled or inactive (false).
</p>
</xsd:documentation>
</annotation>
@@ -155,14 +154,14 @@
<anyAttribute namespace="##other" processContents="lax"/>
</complexType>
- <complexType name="BaseURLRef">
+ <complexType name="Endpoint">
<attribute name="id" type="xsd:int" use="required">
<annotation>
<xsd:documentation
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- An ID uniquely identifying the base URL.
+ An ID uniquely identifying the Endpoint.
</p>
</xsd:documentation>
</annotation>
@@ -173,7 +172,7 @@
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
- A hyperlink reference to the base URL.
+ A hyperlink reference to the URL Endpoint Template.
</p>
</xsd:documentation>
</annotation>
@@ -181,18 +180,18 @@
<anyAttribute namespace="##other" processContents="lax"/>
</complexType>
- <complexType name="BaseURLList">
+ <complexType name="EndpointTemplateList">
<sequence>
- <element name="baseURL" type="idm:BaseURL" minOccurs="0" maxOccurs="unbounded"/>
+ <element name="endpointTemplate" type="idm:EndpointTemplate" minOccurs="0" maxOccurs="unbounded"/>
<element vc:minVersion="1.1" ref="atom:link" minOccurs="0" maxOccurs="unbounded" />
<any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" />
</sequence>
<anyAttribute namespace="##other" processContents="lax"/>
</complexType>
- <complexType name="BaseURLRefList">
+ <complexType name="EndpointList">
<sequence>
- <element name="baseURLRef" type="idm:BaseURLRef" minOccurs="0" maxOccurs="unbounded"/>
+ <element name="endpoint" type="idm:Endpoint" minOccurs="0" maxOccurs="unbounded"/>
<element vc:minVersion="1.1" ref="atom:link" minOccurs="0" maxOccurs="unbounded" />
<any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" />
</sequence>