diff options
| author | Ziad Sawalha <gihub@highbridgellc.com> | 2011-05-23 17:09:55 -0700 |
|---|---|---|
| committer | Ziad Sawalha <gihub@highbridgellc.com> | 2011-05-23 17:09:55 -0700 |
| commit | 15f3c818ff4c131fa2cb1075850657cf95f3223d (patch) | |
| tree | 3781cea53705b5e63a71a562e7ace0e96e8ff7a5 /docs | |
| parent | 79f7346dd5cf10bff17183ee28378fa0e807c1a7 (diff) | |
| parent | 8e759bc6759422920a7ccd9f96ede61ea849e421 (diff) | |
Merge pull request #46 from yogirackspace/master
REST Calls to support roles. DocBook changes.
Diffstat (limited to 'docs')
23 files changed, 621 insertions, 119 deletions
diff --git a/docs/guide/src/docbkx/identity.wadl b/docs/guide/src/docbkx/identity.wadl index 2cad5a48..cade9c07 100644 --- a/docs/guide/src/docbkx/identity.wadl +++ b/docs/guide/src/docbkx/identity.wadl @@ -45,6 +45,38 @@ <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> + </resource> + <resource id="roleRefs" path="roleRefs"> + <method href="#getRoleRefs"/> + <method href="#addRoleRef"/> + <resource id="roleRef" path="{roleId}"> + <param name="roleId" style="template" type="xsd:int"/> + <method href="#getRoleRef"/> + <method href="#deleteRoleRef"/> + </resource> + </resource> + </resource> + </resource> + <resource id="baseURLs" path="baseURLs"> + <method href="#getBaseURLs"/> + <resource id="baseURLId" path="{baseURLId}"> + <param name="baseURLId" style="template" type="xsd:int"/> + <method href="#getBaseURL"/> + </resource> + </resource> + <resource id="roles" path="roles"> + <method href="#getRoles"/> + <resource id="roleId" path="{roleId}"> + <param name="roleId" style="template" type="xsd:int"/> + <method href="#getRole"/> </resource> </resource> </resource> @@ -351,5 +383,349 @@ <representation mediaType="application/json"/> </response> </method> + + <!-- Base URLs --> + + <method name="GET" id="getBaseURLs"> + <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/json"/> + </response> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:identityFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 500 503"> + <representation mediaType="application/json"/> + </response> + </method> + + <method name="GET" id="getBaseURL"> + <response status="200 203"> + <representation mediaType="application/xml" element="identity:baseURL"/> + <representation mediaType="application/json"/> + </response> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="404"> + <representation mediaType="application/xml" element="identity:itemNotFound"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:authFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 404 500 503"> + <representation mediaType="application/json"/> + </response> + </method> + + <method name="GET" id="getBaseURLRefs"> + <response status="200 203"> + <representation mediaType="application/xml" element="identity:baseURLRefs"/> + <representation mediaType="application/json"/> + </response> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:authFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 500 503"> + <representation mediaType="application/json"/> + </response> + </method> + + <method name="POST" id="addBaseURLRef"> + <request> + <representation mediaType="application/xml" element="identity:baseURLRef"/> + <representation mediaType="application/json"/> + </request> + <response status="201"> + <representation mediaType="application/xml" element="identity:baseURLRef"> + <param name="Location" type="xsd:anyURI" style="header"/> + </representation> + <representation mediaType="application/json"> + <param name="Location" type="xsd:anyURI" style="header"/> + </representation> + </response> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="404"> + <representation mediaType="application/xml" element="identity:itemNotFound"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:identityFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 404 500 503"> + <representation mediaType="application/json"/> + </response> + </method> + + <method name="GET" id="getBaseURLRef"> + <response status="200 203"> + <representation mediaType="application/xml" element="identity:baseURLRef"/> + <representation mediaType="application/json"/> + </response> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="404"> + <representation mediaType="application/xml" element="identity:itemNotFound"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:identityFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 404 500 503"> + <representation mediaType="application/json"/> + </response> + </method> + + <method name="DELETE" id="deleteBaseURLRef"> + <response status="204"/> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="404"> + <representation mediaType="application/xml" element="identity:itemNotFound"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:authFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 404 500 503"> + <representation mediaType="application/json"/> + </response> + </method> + + <!--Roles--> + <method name="GET" id="getRoles"> + <request> + <param name="serviceName" style="query" + required="false" type="xsd:string"/> + </request> + <response status="200 203"> + <representation mediaType="application/xml" element="identity:roles"/> + <representation mediaType="application/json"/> + </response> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:identityFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 500 503"> + <representation mediaType="application/json"/> + </response> + </method> + + <method name="GET" id="getRole"> + <response status="200 203"> + <representation mediaType="application/xml" element="identity:role"/> + <representation mediaType="application/json"/> + </response> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="404"> + <representation mediaType="application/xml" element="identity:itemNotFound"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:authFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 404 500 503"> + <representation mediaType="application/json"/> + </response> + </method> + + <method name="GET" id="getRoleRefs"> + <response status="200 203"> + <representation mediaType="application/xml" element="identity:roleRefs"/> + <representation mediaType="application/json"/> + </response> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:authFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 500 503"> + <representation mediaType="application/json"/> + </response> + </method> + + <method name="POST" id="addRoleRef"> + <request> + <representation mediaType="application/xml" element="identity:roleRef"/> + <representation mediaType="application/json"/> + </request> + <response status="201"> + <representation mediaType="application/xml" element="identity:roleRef"> + <param name="Location" type="xsd:anyURI" style="header"/> + </representation> + <representation mediaType="application/json"> + <param name="Location" type="xsd:anyURI" style="header"/> + </representation> + </response> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="404"> + <representation mediaType="application/xml" element="identity:itemNotFound"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:identityFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 404 500 503"> + <representation mediaType="application/json"/> + </response> + </method> + + <method name="GET" id="getRoleRef"> + <response status="200 203"> + <representation mediaType="application/xml" element="identity:roleRef"/> + <representation mediaType="application/json"/> + </response> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="404"> + <representation mediaType="application/xml" element="identity:itemNotFound"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:identityFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 404 500 503"> + <representation mediaType="application/json"/> + </response> + </method> + <method name="DELETE" id="deleteRoleRef"> + <response status="204"/> + <response status="400"> + <representation mediaType="application/xml" element="identity:badRequest"/> + </response> + <response status="401"> + <representation mediaType="application/xml" element="identity:unauthorized"/> + </response> + <response status="403"> + <representation mediaType="application/xml" element="identity:forbidden"/> + </response> + <response status="404"> + <representation mediaType="application/xml" element="identity:itemNotFound"/> + </response> + <response status="500"> + <representation mediaType="application/xml" element="identity:authFault"/> + </response> + <response status="503"> + <representation mediaType="application/xml" element="identity:serviceUnavailable"/> + </response> + <response status="400 401 403 404 500 503"> + <representation mediaType="application/json"/> + </response> + </method> </application> diff --git a/docs/guide/src/docbkx/identitydevguide.xml b/docs/guide/src/docbkx/identitydevguide.xml index 5ea766ab..4418ce42 100644 --- a/docs/guide/src/docbkx/identitydevguide.xml +++ b/docs/guide/src/docbkx/identitydevguide.xml @@ -1404,14 +1404,14 @@ Host: identity.api.openstack.org/v1.1/ <title>Add Role Request: XML</title> <?dbfo keep-together="always"?> <programlisting language="xml"> -<xi:include href="samples/role.xml" parse="text"/> +<xi:include href="samples/roleRef.xml" parse="text"/> </programlisting> </example> <example> <title>Add Role Request: JSON</title> <?dbfo keep-together="always"?> <programlisting language="javascript"> -<xi:include href="samples/role.json" parse="text"/> +<xi:include href="samples/roleRef.json" parse="text"/> </programlisting> </example> </section> diff --git a/docs/guide/src/docbkx/samples/auth.json b/docs/guide/src/docbkx/samples/auth.json index fa56c131..b5fbada2 100644 --- a/docs/guide/src/docbkx/samples/auth.json +++ b/docs/guide/src/docbkx/samples/auth.json @@ -1,19 +1,37 @@ { - "auth" : { - "token": { - "id": "ab48a9efdfedb23ty3494", - "expires": "2010-11-01T03:32:15-05:00" - }, - "user" : { - "groups": { - "group": [ - { - "tenantId" : "1234", - "id": "Admin" - } - ]}, - "username": "jqsmith", - "tenantId": "1234" - } - } + "auth" : { + "token" : { + "id" : "asdasdasd-adsasdads-asdasdasd-adsadsasd", + "expires" : "2010-11-01T03:32:15-05:00" + }, + "serviceCatalog" : { + "service1" : [ + { + "region" : "DFW", + "publicURL" : "https://service1-public/v1/blah-blah", + "internalURL" : "https://service1-internal/v1/blah-blah" + }, + { + "region" : "ORD", + "publicURL" : "https://service1-public-ord/v1/blah-blah", + "internalURL" : "https://service1-internal-ord/v1/blah-blah" + } + ], + "service2" : [ + { + "region" : "DFW", + "publicURL" : "https://service2-public-dfw/v1/blah-blah", + }, + { + "region" : "ORD", + "publicURL" : "https://service2-public-orf/v1/blah-blah", + } + ], + "service3" : [ + { + "publicURL" : "https://service3-public/v1/blah-blah", + } + ] + } + } } diff --git a/docs/guide/src/docbkx/samples/auth.xml b/docs/guide/src/docbkx/samples/auth.xml index 0e114a64..6d90c064 100644 --- a/docs/guide/src/docbkx/samples/auth.xml +++ b/docs/guide/src/docbkx/samples/auth.xml @@ -2,9 +2,28 @@ <auth xmlns="http://docs.openstack.org/identity/api/v2.0"> <token expires="2010-11-01T03:32:15-05:00" id="ab48a9efdfedb23ty3494"/> - <user tenantId="1245" username="jqsmith"> - <groups> - <group tenantId="1245" id="Admin"/> - </groups> - </user> + <serviceCatalog> + <service name="service1"> + <endpoint + region="DFW" + publicURL="https://service1.public.com/v2.0/blah-blah" + internalURL="https://service1.internal.com/v2.0/blah-blah"/> + <endpoint + region="ORD" + publicURL="https://service1.public.com/v2.0/blah-blah" + internalURL="https://service1.internal.com/v2.0/blah-blah"/> + </service> + <service name="service2"> + <endpoint + region="DFW" + publicURL="https://service2.public.com/v2.0/blah-blah"/> + <endpoint + region="ORD" + publicURL="https://service2.public.com/v2.0/blah-blah"/> + </service> + <service name="service3"> + <endpoint + publicURL="https://service3.public.com/v2.0/blah-blah"/> + </service> + </serviceCatalog> </auth> diff --git a/docs/guide/src/docbkx/samples/baseURL.json b/docs/guide/src/docbkx/samples/baseURL.json index c07d943c..534484aa 100644 --- a/docs/guide/src/docbkx/samples/baseURL.json +++ b/docs/guide/src/docbkx/samples/baseURL.json @@ -2,12 +2,11 @@ "baseURL" : { "id" : 1, - "userType" : "NAST", "region" : "DFW", "default" : true, - "serviceName" : "cloudFiles", - "publicURL" : "https://storage.clouddrive.com/v1", - "internalURL" : "https://storage-snet.clouddrive.com/v1", + "serviceName" : "service1", + "publicURL" : "https://service-public.com/v1", + "internalURL" : "https://service-internal.com/v1", "enabled" : true } } diff --git a/docs/guide/src/docbkx/samples/baseURL.xml b/docs/guide/src/docbkx/samples/baseURL.xml index 415fbf10..a66d5516 100644 --- a/docs/guide/src/docbkx/samples/baseURL.xml +++ b/docs/guide/src/docbkx/samples/baseURL.xml @@ -3,11 +3,10 @@ <baseURL xmlns="http://docs.openstack.org/identity/api/v2.0" id="1" - userType="NAST" region="DFW" default="true" - serviceName="cloudFiles" - publicURL="https://storage.clouddrive.com/v1" - internalURL="https://storage-snet.clouddrive.com/v1" + serviceName="service1" + publicURL="https://service-public.com/v1" + internalURL="https://service-internal.com/v1" enabled="true" /> diff --git a/docs/guide/src/docbkx/samples/baseURLRef.json b/docs/guide/src/docbkx/samples/baseURLRef.json index 4e0cd4b2..aed01500 100644 --- a/docs/guide/src/docbkx/samples/baseURLRef.json +++ b/docs/guide/src/docbkx/samples/baseURLRef.json @@ -1,6 +1,5 @@ { "baseURLRef" : { - "id" : 3, - "v1Default" : true + "id" : 3 } } diff --git a/docs/guide/src/docbkx/samples/baseURLRef.xml b/docs/guide/src/docbkx/samples/baseURLRef.xml index b9dc8c46..16c71870 100644 --- a/docs/guide/src/docbkx/samples/baseURLRef.xml +++ b/docs/guide/src/docbkx/samples/baseURLRef.xml @@ -1,4 +1,4 @@ <?xml version="1.0" encoding="UTF-8"?> <baseURLRef xmlns="http://docs.openstack.org/identity/api/v2.0" - id="3" v1Default="true"/> + id="3" /> diff --git a/docs/guide/src/docbkx/samples/baseURLRefs.json b/docs/guide/src/docbkx/samples/baseURLRefs.json index 30e56d45..a815f2b9 100644 --- a/docs/guide/src/docbkx/samples/baseURLRefs.json +++ b/docs/guide/src/docbkx/samples/baseURLRefs.json @@ -2,26 +2,23 @@ "baseURLRefs" : [ { "id" : 1, - "href" : "https://auth.api.rackspacecloud.com/v1.1/baseURLs/1", - "v1Default" : true + "href" : "https://auth.keystone.com/v2.0/baseURLs/1" }, { - "id" : 2, - "href" : "https://auth.api.rackspacecloud.com/v1.1/baseURLs/2" + "id" : 2 + "href" : "https://auth.keystone.com/v2.0/baseURLs/2" }, { "id" : 3, - "href" : "https://auth.api.rackspacecloud.com/v1.1/baseURLs/3", - "v1Default" : true + "href" : "https://auth.keystone.com/v2.0/baseURLs/3" }, { "id" : 4, - "href" : "https://auth.api.rackspacecloud.com/v1.1/baseURLs/4" + "href" : "https://auth.keystone.com/v2.0/baseURLs/4" }, { "id" : 5, - "href" : "https://auth.api.rackspacecloud.com/v1.1/baseURLs/5", - "v1Default" : true + "href" : "https://auth.keystone.com/v2.0/baseURLs/5" } ] } diff --git a/docs/guide/src/docbkx/samples/baseURLRefs.xml b/docs/guide/src/docbkx/samples/baseURLRefs.xml index 51029ff5..0c095626 100644 --- a/docs/guide/src/docbkx/samples/baseURLRefs.xml +++ b/docs/guide/src/docbkx/samples/baseURLRefs.xml @@ -3,18 +3,18 @@ <baseURLRefs xmlns="http://docs.openstack.org/identity/api/v2.0"> <baseURLRef - href="https://auth.api.rackspacecloud.com/v1.1/baseURLs/1" - id="1" v1Default="true" /> + href="https://auth.keystone.com/v2.0/baseURLs/1" + id="1" /> <baseURLRef - href="https://auth.api.rackspacecloud.com/v1.1/baseURLs/2" + href="https://auth.keystone.com/v2.0/baseURLs/2" id="2" /> <baseURLRef - href="https://auth.api.rackspacecloud.com/v1.1/baseURLs/3" - id="3" v1Default="true" /> + href="https://auth.keystone.com/v2.0/baseURLs/3" + id="3" /> <baseURLRef - href="https://auth.api.rackspacecloud.com/v1.1/baseURLs/4" + href="https://auth.keystone.com/v2.0/baseURLs/4" id="4" /> <baseURLRef - href="https://auth.api.rackspacecloud.com/v1.1/baseURLs/5" - id="5" v1Default="true" /> + href="https://auth.keystone.com/v2.0/baseURLs/5" + id="5" /> </baseURLRefs> diff --git a/docs/guide/src/docbkx/samples/baseURLs.json b/docs/guide/src/docbkx/samples/baseURLs.json index 58b5bd24..da3d1d14 100644 --- a/docs/guide/src/docbkx/samples/baseURLs.json +++ b/docs/guide/src/docbkx/samples/baseURLs.json @@ -2,46 +2,41 @@ "baseURLs" : [ { "id" : 1, - "userType" : "NAST", "region" : "DFW", "default" : true, - "serviceName" : "cloudFiles", - "publicURL" : "https://storage.clouddrive.com/v1", - "internalURL" : "https://storage-snet.clouddrive.com/v1", + "serviceName" : "service1", + "publicURL" : "https://service1.public.com/v1", + "internalURL" : "https://service1.internal.com/v1", "enabled" : true }, { "id" : 2, - "userType" : "NAST", "region" : "ORD", - "serviceName" : "cloudFiles", - "publicURL" : "https://otherstorage.clouddrive.com/v1", - "internalURL" : "https://otherstorage-snet.clouddrive.com/v1", + "serviceName" : "service2", + "publicURL" : "https://service2.public.com/v1", + "internalURL" : "https://service2.internal.com/v1", "enabled" : false }, { "id" : 3, - "userType" : "NAST", "region" : "DFW", "default" : true, - "serviceName" : "cloudFilesCDN", - "publicURL" : "https://cdn.clouddrive.com/v1", + "serviceName" : "service1", + "publicURL" : "https://service.public.com/v1", "enabled" : true }, { "id" : 4, - "userType" : "NAST", "region" : "ORD", - "serviceName" : "cloudFilesCDN", - "publicURL" : "https://othercdn.clouddrive.com/v1", + "serviceName" : "service2", + "publicURL" : "https://service2.public.com/v1", "enabled" : true }, { "id" : 5, - "userType" : "MOSSO", "default" : true, - "serviceName" : "cloudServers", - "publicURL" : "https://servers.api.rackspacecloud.com/v1.0", + "serviceName" : "service3", + "publicURL" : "https://service3.public.com/v1.0", "enabled" : true } ] diff --git a/docs/guide/src/docbkx/samples/baseURLs.xml b/docs/guide/src/docbkx/samples/baseURLs.xml index 0faa3a5b..9f829e9d 100644 --- a/docs/guide/src/docbkx/samples/baseURLs.xml +++ b/docs/guide/src/docbkx/samples/baseURLs.xml @@ -3,45 +3,40 @@ <baseURLs xmlns="http://docs.openstack.org/identity/api/v2.0"> <baseURL id="1" - userType="NAST" region="DFW" default="true" - serviceName="cloudFiles" - publicURL="https://storage.clouddrive.com/v1" - internalURL="https://storage-snet.clouddrive.com/v1" + serviceName="service1" + publicURL="https://service1.public.com/v1" + internalURL="https://service1.internal.clouddrive.com/v1" enabled="true" /> <baseURL id="2" - userType="NAST" region="ORD" - serviceName="cloudFiles" - publicURL="https://otherstorage.clouddrive.com/v1" - internalURL="https://otherstorage-snet.clouddrive.com/v1" + serviceName="service2" + publicURL="https://service2.public.com/v1" + internalURL="https://service2.internal.public.com/v1" enabled="false" /> <baseURL id="3" - userType="NAST" region="DFW" default="true" - serviceName="cloudFilesCDN" - publicURL="https://cdn.clouddrive.com/v1" + serviceName="service1" + publicURL="https://service1.public.com/v1" enabled="true" /> <baseURL id="4" - userType="NAST" region="ORD" - serviceName="cloudFilesCDN" - publicURL="https://othercdn.clouddrive.com/v1" + serviceName="service2" + publicURL="https://service2.public.com/v1" enabled="true" /> <baseURL id="5" - userType="MOSSO" default="true" - serviceName="cloudServers" - publicURL="https://servers.api.rackspacecloud.com/v1.0" + serviceName="service3" + publicURL="https://service3.public.com/v1" /> </baseURLs> diff --git a/docs/guide/src/docbkx/samples/role.json b/docs/guide/src/docbkx/samples/role.json index 08c360e1..d52e2c76 100644 --- a/docs/guide/src/docbkx/samples/role.json +++ b/docs/guide/src/docbkx/samples/role.json @@ -2,6 +2,6 @@ "role" : { "id" : "Admin", - "serviceName" : "cloudFiles" + "description" : "cloudFiles" } }
\ No newline at end of file diff --git a/docs/guide/src/docbkx/samples/role.xml b/docs/guide/src/docbkx/samples/role.xml index 50353631..5a4ecf19 100644 --- a/docs/guide/src/docbkx/samples/role.xml +++ b/docs/guide/src/docbkx/samples/role.xml @@ -1,7 +1,4 @@ <?xml version="1.0" encoding="UTF-8"?> -<role - xmlns="http://docs.openstack.org/identity/api/v2.0" - id="Admin" - serviceName="cloudFiles" - /> +<role xmlns="http://docs.openstack.org/identity/api/v2.0" id="Admin" + description="cloudFiles" /> diff --git a/docs/guide/src/docbkx/samples/roleRefs.json b/docs/guide/src/docbkx/samples/roleRefs.json index a4300231..77819d44 100644 --- a/docs/guide/src/docbkx/samples/roleRefs.json +++ b/docs/guide/src/docbkx/samples/roleRefs.json @@ -1,14 +1,14 @@ { "roleRefs" : [ { - "id" : 1, - "href" : "https://.openstack.org/identity/v1.1/roles/admin", - "tenantId" : "one" + "id" : 1, + "href" : "https://.openstack.org/identity/v2.0/roles/admin", + "tenantId" : "one" }, { - "id" : 2, - "href" : "https://.openstack.org/identity/v1.1/roles/test", - "tenantId" : "two" - }, + "id" : 2, + "href" : "https://.openstack.org/identity/v2.0/roles/test", + "tenantId" : "two" + } ] } diff --git a/docs/guide/src/docbkx/samples/roleRefs.xml b/docs/guide/src/docbkx/samples/roleRefs.xml index 36906df4..284154ce 100644 --- a/docs/guide/src/docbkx/samples/roleRefs.xml +++ b/docs/guide/src/docbkx/samples/roleRefs.xml @@ -3,7 +3,7 @@ <roleRefs xmlns="http://docs.openstack.org/identity/api/v2.0"> <roleRef xmlns="http://docs.openstack.org/identity/api/v2.0" - href="https://.openstack.org/identity/v1.1/roles/admin" id="3" tenantId="tenantId"/> + href="https://.openstack.org/identity/v2.0/roles/admin" id="3" tenantId="tenantId"/> <roleRef xmlns="http://docs.openstack.org/identity/api/v2.0" - href="https://.openstack.org/identity/v1.1/roles/test" id="4" tenantId="tenantId"/> + href="https://.openstack.org/identity/v2.0/roles/test" id="4" tenantId="tenantId"/> </roleRefs> diff --git a/docs/guide/src/docbkx/samples/roles.json b/docs/guide/src/docbkx/samples/roles.json index 091ecbe8..5d5636ea 100644 --- a/docs/guide/src/docbkx/samples/roles.json +++ b/docs/guide/src/docbkx/samples/roles.json @@ -2,11 +2,11 @@ "roles" : [ { "id" : 1, - "serviceName" : "cloudFiles" + "description" : "cloudFiles" }, { "id" : 2, - "serviceName" : "cloudFiles" + "description" : "cloudFiles" }, ] } diff --git a/docs/guide/src/docbkx/samples/roles.xml b/docs/guide/src/docbkx/samples/roles.xml index 32073f63..53fbdf73 100644 --- a/docs/guide/src/docbkx/samples/roles.xml +++ b/docs/guide/src/docbkx/samples/roles.xml @@ -1,12 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <roles xmlns="http://docs.openstack.org/identity/api/v2.0"> - <role - id="4" - serviceName="cloudFilesCDN" - /> - <role - id="5" - serviceName="cloudServers" - /> + <role id="4" description="cloudFilesCDN" /> + <role id="5" description="cloudServers" /> </roles>
\ No newline at end of file diff --git a/docs/guide/src/docbkx/samples/validatetoken.json b/docs/guide/src/docbkx/samples/validatetoken.json index c4721873..6c9f16f9 100644 --- a/docs/guide/src/docbkx/samples/validatetoken.json +++ b/docs/guide/src/docbkx/samples/validatetoken.json @@ -12,6 +12,14 @@ "name": "Admin" } ]}, + "roleRefs": { + "roleRef" : [ + { + "id" : 1, + "href" : "https://.openstack.org/identity/v2.0/roles/admin", + "tenantId" : "one" + } + ]}, "username": "jqsmith", "tenantId": "1234", } diff --git a/docs/guide/src/docbkx/samples/validatetoken.xml b/docs/guide/src/docbkx/samples/validatetoken.xml index e04742ae..af40a8b6 100644 --- a/docs/guide/src/docbkx/samples/validatetoken.xml +++ b/docs/guide/src/docbkx/samples/validatetoken.xml @@ -6,5 +6,9 @@ <groups> <group tenantId="1245" name="Admin"/> </groups> + <roleRefs> + <roleRef href="https://.openstack.org/identity/v2.0/roles/admin" id="3" tenantId="tenantId"/> + <roleRef href="https://.openstack.org/identity/v2.0/roles/test" id="4" tenantId="tenantId"/> + </roleRefs> </user> </auth> diff --git a/docs/guide/src/docbkx/xsd/api.xsd b/docs/guide/src/docbkx/xsd/api.xsd index d4603c2e..a23abd99 100644 --- a/docs/guide/src/docbkx/xsd/api.xsd +++ b/docs/guide/src/docbkx/xsd/api.xsd @@ -11,4 +11,6 @@ <include schemaLocation="token.xsd"/> <include schemaLocation="tenant.xsd"/> <include schemaLocation="fault.xsd"/> + <include schemaLocation="baseURLs.xsd"/> + <include schemaLocation="roles.xsd"/> </schema> diff --git a/docs/guide/src/docbkx/xsd/roles.xsd b/docs/guide/src/docbkx/xsd/roles.xsd index 4ae8449b..6f8cc207 100644 --- a/docs/guide/src/docbkx/xsd/roles.xsd +++ b/docs/guide/src/docbkx/xsd/roles.xsd @@ -62,9 +62,16 @@ <!-- Complex Types --> <complexType name="Role"> <attribute name="id" type="xsd:string" use="required"/> - <attribute name="service" type="xsd:string" use="optional"/> + <attribute name="description" type="xsd:string" use="optional"/> </complexType> + <complexType name="RoleList"> + <sequence> + <element name="role" type="idm:Role" minOccurs="0" maxOccurs="unbounded"/> + </sequence> + </complexType> + + <complexType name="RoleRef"> <attribute name="id" type="xsd:int" use="required"/> <attribute name="tenantId" type="xsd:string" use="required" /> @@ -81,11 +88,6 @@ </attribute> </complexType> - <complexType name="RoleList"> - <sequence> - <element name="role" type="idm:Role" minOccurs="0" maxOccurs="unbounded"/> - </sequence> - </complexType> <complexType name="RoleRefList"> <sequence> diff --git a/docs/guide/src/docbkx/xsd/token.xsd b/docs/guide/src/docbkx/xsd/token.xsd index 888bbebf..5e9aae46 100644 --- a/docs/guide/src/docbkx/xsd/token.xsd +++ b/docs/guide/src/docbkx/xsd/token.xsd @@ -8,6 +8,7 @@ xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://docs.openstack.org/identity/api/v2.0" > + <include schemaLocation="roles.xsd"/> <!-- Elements --> <element name="passwordCredentials" type="identity:PasswordCredentials"/> <element name="auth" type="identity:AuthData"/> @@ -32,11 +33,12 @@ <sequence> <element name="token" type="identity:Token"/> <element name="user" type="identity:User"/> + <element name="serviceCatalog" type="identity:ServiceCatalog"/> <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" /> </sequence> <anyAttribute namespace="##other" processContents="lax"/> </complexType> - + <complexType name="Token"> <sequence> <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" /> @@ -49,6 +51,7 @@ <complexType name="User"> <sequence> <element name="groups" type="identity:Groups" /> + <element name="roleRefs" type="identity:RoleRefList" /> <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" /> </sequence> <attribute name="tenantId" type="xsd:string"/> @@ -63,10 +66,105 @@ </sequence> <anyAttribute namespace="##other" processContents="lax"/> </complexType> - + <complexType name="Group"> <attribute name="id" type="xsd:string" use="required"/> <attribute name="tenantId" type="xsd:string" use="optional"/> <anyAttribute namespace="##other" processContents="lax"/> </complexType> + + <complexType name="ServiceCatalog"> + <sequence> + <element name="service" type="identity:Service" minOccurs="1" maxOccurs="unbounded"> + <annotation> + <xsd:documentation + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml"> + <p> + A list of services. + </p> + </xsd:documentation> + </annotation> + </element> + </sequence> + <anyAttribute namespace="##other" processContents="lax"/> + </complexType> + <complexType name="Service"> + <sequence> + <element name="endpoint" type="identity:Endpoint" minOccurs="1" maxOccurs="unbounded"> + <annotation> + <xsd:documentation + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml"> + <p> + A list of endpoints. + </p> + </xsd:documentation> + </annotation> + </element> + </sequence> + <attribute name="name" type="xsd:ID" use="required"> + <annotation> + <xsd:documentation + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml"> + <p> + The service name. + </p> + </xsd:documentation> + </annotation> + </attribute> + <anyAttribute namespace="##other" processContents="lax"/> + </complexType> + <complexType name="Endpoint"> + <attribute name="region" type="xsd:string" use="optional"> + <annotation> + <xsd:documentation + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml"> + <p> + The airport code of the region where the endpoint + lives. + </p> + </xsd:documentation> + </annotation> + </attribute> + <attribute name="publicURL" type="xsd:anyURI" use="required"> + <annotation> + <xsd:documentation + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml"> + <p> + The publically accessible service URL. + </p> + </xsd:documentation> + </annotation> + </attribute> + <attribute name="internalURL" type="xsd:anyURI" use="optional"> + <annotation> + <xsd:documentation + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml"> + <p> + A service URL, accessible only within the + Rackspace Cloud. + </p> + </xsd:documentation> + </annotation> + </attribute> + <attribute name="adminURL" type="xsd:anyURI" use="optional"> + <annotation> + <xsd:documentation + xml:lang="EN" + xmlns="http://www.w3.org/1999/xhtml"> + <p> + A service URL used for administration. This may expose + additional functionality not found in the public and + internal URL. + </p> + </xsd:documentation> + </annotation> + </attribute> + <anyAttribute namespace="##other" processContents="lax"/> + </complexType> </schema> |
