From 3ff465077849d66f62219fb6e84f9feec8a6a670 Mon Sep 17 00:00:00 2001 From: Ziad Sawalha Date: Thu, 14 Jul 2011 23:32:28 -0500 Subject: [PATCH] Move dev guide to OpenStack --- README.md | 6 +- doc/guide/pom.xml | 99 - doc/guide/src/docbkx/identity.wadl | 1024 --------- doc/guide/src/docbkx/identitydevguide.xml | 1915 ----------------- .../src/docbkx/img/Check_mark_23x20_02.svg | 60 - doc/guide/src/docbkx/samples/auth.json | 37 - doc/guide/src/docbkx/samples/auth.xml | 29 - .../src/docbkx/samples/auth_credentials.json | 7 - .../src/docbkx/samples/auth_credentials.xml | 5 - doc/guide/src/docbkx/samples/choices.json | 72 - doc/guide/src/docbkx/samples/choices.xml | 41 - doc/guide/src/docbkx/samples/endpoint.json | 6 - doc/guide/src/docbkx/samples/endpoint.xml | 4 - .../src/docbkx/samples/endpointTemplate.json | 11 - .../src/docbkx/samples/endpointTemplate.xml | 12 - .../src/docbkx/samples/endpointTemplates.json | 43 - .../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/samples/ext-getuser.json | 22 - doc/guide/src/docbkx/samples/ext-getuser.xml | 13 - doc/guide/src/docbkx/samples/extension.json | 21 - doc/guide/src/docbkx/samples/extension.xml | 23 - doc/guide/src/docbkx/samples/extensions.json | 44 - doc/guide/src/docbkx/samples/extensions.xml | 39 - doc/guide/src/docbkx/samples/getuser-1.json | 29 - doc/guide/src/docbkx/samples/getuser-1.xml | 14 - doc/guide/src/docbkx/samples/group.json | 6 - doc/guide/src/docbkx/samples/group.xml | 4 - doc/guide/src/docbkx/samples/groups.json | 13 - doc/guide/src/docbkx/samples/groups.xml | 5 - .../src/docbkx/samples/identity_fault.json | 7 - .../src/docbkx/samples/identity_fault.xml | 6 - .../src/docbkx/samples/item_not_found.json | 7 - .../src/docbkx/samples/item_not_found.xml | 6 - doc/guide/src/docbkx/samples/role.json | 7 - doc/guide/src/docbkx/samples/role.xml | 4 - doc/guide/src/docbkx/samples/roleRef.json | 7 - doc/guide/src/docbkx/samples/roleRef.xml | 4 - doc/guide/src/docbkx/samples/roleRefs.json | 14 - doc/guide/src/docbkx/samples/roleRefs.xml | 9 - doc/guide/src/docbkx/samples/roles.json | 12 - doc/guide/src/docbkx/samples/roles.xml | 6 - .../docbkx/samples/samplerequestheader.json | 4 - .../docbkx/samples/sampleresponseheader.json | 4 - doc/guide/src/docbkx/samples/tenant.json | 7 - doc/guide/src/docbkx/samples/tenant.xml | 5 - doc/guide/src/docbkx/samples/tenantlock.json | 5 - doc/guide/src/docbkx/samples/tenantlock.xml | 4 - doc/guide/src/docbkx/samples/tenants-1.json | 17 - doc/guide/src/docbkx/samples/tenants-1.xml | 10 - doc/guide/src/docbkx/samples/tenants-2.json | 21 - doc/guide/src/docbkx/samples/tenants-2.xml | 13 - doc/guide/src/docbkx/samples/tenants-3.json | 17 - doc/guide/src/docbkx/samples/tenants-3.xml | 10 - .../src/docbkx/samples/tenants-request.txt | 5 - doc/guide/src/docbkx/samples/tenants.json | 21 - doc/guide/src/docbkx/samples/tenants.xml | 14 - .../src/docbkx/samples/updatedtenant.json | 7 - .../src/docbkx/samples/updatedtenant.xml | 5 - .../src/docbkx/samples/validatetoken.json | 20 - .../src/docbkx/samples/validatetoken.xml | 12 - doc/guide/src/docbkx/samples/version-atom.xml | 19 - doc/guide/src/docbkx/samples/version.json | 33 - doc/guide/src/docbkx/samples/version.xml | 23 - .../src/docbkx/samples/versions-atom.xml | 29 - doc/guide/src/docbkx/samples/versions.json | 39 - doc/guide/src/docbkx/samples/versions.xml | 24 - doc/guide/src/docbkx/xsd/api-common.xsd | 56 - doc/guide/src/docbkx/xsd/api.xsd | 17 - doc/guide/src/docbkx/xsd/atom/atom.xsd | 115 - doc/guide/src/docbkx/xsd/atom/xml.xsd | 287 --- doc/guide/src/docbkx/xsd/endpoints.xsd | 200 -- doc/guide/src/docbkx/xsd/extensions.xsd | 56 - doc/guide/src/docbkx/xsd/fault.xsd | 135 -- doc/guide/src/docbkx/xsd/roles.xsd | 112 - doc/guide/src/docbkx/xsd/tenant.xsd | 40 - doc/guide/src/docbkx/xsd/token.xsd | 170 -- doc/guide/src/docbkx/xsd/user.xsd | 100 - doc/guide/src/docbkx/xsd/version.xsd | 200 -- 80 files changed, 3 insertions(+), 5632 deletions(-) delete mode 100644 doc/guide/pom.xml delete mode 100644 doc/guide/src/docbkx/identity.wadl delete mode 100755 doc/guide/src/docbkx/identitydevguide.xml delete mode 100644 doc/guide/src/docbkx/img/Check_mark_23x20_02.svg delete mode 100644 doc/guide/src/docbkx/samples/auth.json delete mode 100644 doc/guide/src/docbkx/samples/auth.xml delete mode 100644 doc/guide/src/docbkx/samples/auth_credentials.json delete mode 100644 doc/guide/src/docbkx/samples/auth_credentials.xml delete mode 100644 doc/guide/src/docbkx/samples/choices.json delete mode 100644 doc/guide/src/docbkx/samples/choices.xml delete mode 100644 doc/guide/src/docbkx/samples/endpoint.json delete mode 100644 doc/guide/src/docbkx/samples/endpoint.xml delete mode 100644 doc/guide/src/docbkx/samples/endpointTemplate.json delete mode 100644 doc/guide/src/docbkx/samples/endpointTemplate.xml delete mode 100644 doc/guide/src/docbkx/samples/endpointTemplates.json delete mode 100644 doc/guide/src/docbkx/samples/endpointTemplates.xml delete mode 100644 doc/guide/src/docbkx/samples/endpoints.json delete mode 100644 doc/guide/src/docbkx/samples/endpoints.xml delete mode 100644 doc/guide/src/docbkx/samples/ext-getuser.json delete mode 100644 doc/guide/src/docbkx/samples/ext-getuser.xml delete mode 100644 doc/guide/src/docbkx/samples/extension.json delete mode 100644 doc/guide/src/docbkx/samples/extension.xml delete mode 100644 doc/guide/src/docbkx/samples/extensions.json delete mode 100644 doc/guide/src/docbkx/samples/extensions.xml delete mode 100644 doc/guide/src/docbkx/samples/getuser-1.json delete mode 100644 doc/guide/src/docbkx/samples/getuser-1.xml delete mode 100644 doc/guide/src/docbkx/samples/group.json delete mode 100644 doc/guide/src/docbkx/samples/group.xml delete mode 100644 doc/guide/src/docbkx/samples/groups.json delete mode 100644 doc/guide/src/docbkx/samples/groups.xml delete mode 100644 doc/guide/src/docbkx/samples/identity_fault.json delete mode 100644 doc/guide/src/docbkx/samples/identity_fault.xml delete mode 100644 doc/guide/src/docbkx/samples/item_not_found.json delete mode 100644 doc/guide/src/docbkx/samples/item_not_found.xml delete mode 100644 doc/guide/src/docbkx/samples/role.json delete mode 100644 doc/guide/src/docbkx/samples/role.xml delete mode 100644 doc/guide/src/docbkx/samples/roleRef.json delete mode 100644 doc/guide/src/docbkx/samples/roleRef.xml delete mode 100644 doc/guide/src/docbkx/samples/roleRefs.json delete mode 100644 doc/guide/src/docbkx/samples/roleRefs.xml delete mode 100644 doc/guide/src/docbkx/samples/roles.json delete mode 100644 doc/guide/src/docbkx/samples/roles.xml delete mode 100644 doc/guide/src/docbkx/samples/samplerequestheader.json delete mode 100644 doc/guide/src/docbkx/samples/sampleresponseheader.json delete mode 100644 doc/guide/src/docbkx/samples/tenant.json delete mode 100644 doc/guide/src/docbkx/samples/tenant.xml delete mode 100644 doc/guide/src/docbkx/samples/tenantlock.json delete mode 100644 doc/guide/src/docbkx/samples/tenantlock.xml delete mode 100644 doc/guide/src/docbkx/samples/tenants-1.json delete mode 100644 doc/guide/src/docbkx/samples/tenants-1.xml delete mode 100644 doc/guide/src/docbkx/samples/tenants-2.json delete mode 100644 doc/guide/src/docbkx/samples/tenants-2.xml delete mode 100644 doc/guide/src/docbkx/samples/tenants-3.json delete mode 100644 doc/guide/src/docbkx/samples/tenants-3.xml delete mode 100644 doc/guide/src/docbkx/samples/tenants-request.txt delete mode 100644 doc/guide/src/docbkx/samples/tenants.json delete mode 100644 doc/guide/src/docbkx/samples/tenants.xml delete mode 100644 doc/guide/src/docbkx/samples/updatedtenant.json delete mode 100644 doc/guide/src/docbkx/samples/updatedtenant.xml delete mode 100644 doc/guide/src/docbkx/samples/validatetoken.json delete mode 100644 doc/guide/src/docbkx/samples/validatetoken.xml delete mode 100644 doc/guide/src/docbkx/samples/version-atom.xml delete mode 100644 doc/guide/src/docbkx/samples/version.json delete mode 100644 doc/guide/src/docbkx/samples/version.xml delete mode 100644 doc/guide/src/docbkx/samples/versions-atom.xml delete mode 100644 doc/guide/src/docbkx/samples/versions.json delete mode 100644 doc/guide/src/docbkx/samples/versions.xml delete mode 100644 doc/guide/src/docbkx/xsd/api-common.xsd delete mode 100755 doc/guide/src/docbkx/xsd/api.xsd delete mode 100644 doc/guide/src/docbkx/xsd/atom/atom.xsd delete mode 100644 doc/guide/src/docbkx/xsd/atom/xml.xsd delete mode 100644 doc/guide/src/docbkx/xsd/endpoints.xsd delete mode 100644 doc/guide/src/docbkx/xsd/extensions.xsd delete mode 100644 doc/guide/src/docbkx/xsd/fault.xsd delete mode 100755 doc/guide/src/docbkx/xsd/roles.xsd delete mode 100644 doc/guide/src/docbkx/xsd/tenant.xsd delete mode 100644 doc/guide/src/docbkx/xsd/token.xsd delete mode 100755 doc/guide/src/docbkx/xsd/user.xsd delete mode 100644 doc/guide/src/docbkx/xsd/version.xsd diff --git a/README.md b/README.md index 93905a9c03..69ea50b5c7 100644 --- a/README.md +++ b/README.md @@ -168,14 +168,14 @@ information is therefore called a `Developer Guide`. Developer in this case is n working on the Keystone source code itself. The [dev guide](https://github.com/rackspace/keystone/raw/master/keystone/content/identitydevguide.pdf) is automatically -generated from XML and other artifacts in the `doc/guide` folder. +generated from XML and other artifacts that live in the [OpenStack Manuals project](https://launchpad.net/openstack-manuals). To build the Developer Guide from source, you need [Maven](http://maven.apache.org/). To build the docs and publish a new PDF: - $ cd doc/guide + $ cd to folder with the pom.xml file $ mvn clean generate-sources && cp target/docbkx/pdf/identitydevguide.pdf ../../keystone/content/identitydevguide.pdf -The output will go into the `doc/guide/target` folder (the source is in `doc/guide/src`). Output generated is PDF and webhelp. +The output will go into the `target` folder (the source is in `src`). Output generated is PDF and webhelp. ### Editing and Compiling the Admin Guide diff --git a/doc/guide/pom.xml b/doc/guide/pom.xml deleted file mode 100644 index fd16d6a33c..0000000000 --- a/doc/guide/pom.xml +++ /dev/null @@ -1,99 +0,0 @@ - - 4.0.0 - - org.openstack.identity - docs - 0.0.1-SNAPSHOT - jar - - docs - http://maven.apache.org - - - UTF-8 - - - - - junit - junit - 3.8.1 - test - - - com.sun.xml.bind - jaxb-impl - 2.1.12 - - - com.thoughtworks.xstream - xstream - 1.3.1 - - - org.codehaus.jettison - jettison - 1.1 - - - - - - target/docbkx/pdf - - **/*.fo - - - - - - com.rackspace.cloud.api - clouddocs-maven-plugin - 1.0.4-SNAPSHOT - - - - generate-pdf - generate-webhelp - - generate-sources - - - - - org.docbook - docbook-xml - 4.4 - runtime - - - - true - - - - - - - Rackspace Research Repositories - - true - - - - rackspace-research - Rackspace Research Repository - http://maven.research.rackspacecloud.com/content/groups/public/ - - - - - rackspace-research - Rackspace Research Repository - http://maven.research.rackspacecloud.com/content/groups/public/ - - - - - diff --git a/doc/guide/src/docbkx/identity.wadl b/doc/guide/src/docbkx/identity.wadl deleted file mode 100644 index 18d6e87230..0000000000 --- a/doc/guide/src/docbkx/identity.wadl +++ /dev/null @@ -1,1024 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/guide/src/docbkx/identitydevguide.xml b/doc/guide/src/docbkx/identitydevguide.xml deleted file mode 100755 index 18426a67fd..0000000000 --- a/doc/guide/src/docbkx/identitydevguide.xml +++ /dev/null @@ -1,1915 +0,0 @@ - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - - '> - - - - This operation does not require a request body.'> - - - Verb - URI - Description - - '> - - - Verb - URI - Description - - '> -]> - - Keystone Developer Guide - - - - - - - - OpenStack - - - - 2010 - 2011 - OpenStack - - API v2.0 - Keystone - OpenStack Identity - 2011-06-22 - - - Copyright details are filled in by the template. - - - - - This document is intended for software developers interested - in developing applications that utilize the Cloud Identity - Service for authentication. This document also includes - details on how to integrate services with the Cloud Identity - Service. - - - - - Overview - - The Keystone Identity Service allows applications to obtain - tokens that can be used to access OpenStack resources. This - document is intended for software developers interested in - developing applications that utilize the Cloud Identity - Service for authentication. This document also includes - details on how to integrate services with the Cloud Identity - Service. - - - This Guide assumes the reader is familiar with RESTful web - services, HTTP/1.1, and JSON and/or XML serialization formats. - - - - Concepts - - The Keystone Identity Service has several key concepts which are - important to understand: - -
- Token - - A token is an arbitrary bit of text that is used to access - resources. Each token has a scope which describes which - resources are accessible with it. A token may be - revoked at anytime and is valid for a finite duration. - - - While Keystone supports token-based authentication in this release, - the intention is for it to support additional protocols in the - future. The desire is for it to be an integration service, and not - a full-fledged identity store and management solution. - -
-
- Tenant - - A container used to group or isolate resources and/or identity - objects. Depending on the service operator, a tenant may map to a customer, - account, organization, or project. - -
-
- User - - Users have a login and may be assigned tokens to access - resources. Users may be directly assigned to a particular tenant and - 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 - - A role that an identity is associated with that allows it - to perform certain operations. Roles are managed by services - and operators. Tenant administrators may assign roles to users. - -
- - - General API Information - The Keystone API is implemented using a RESTful web service interface. All requests to - authenticate and operate against the Keystone API are performed using SSL over HTTP (HTTPS) on TCP - port 443. -
- Request/Response Types - The Keystone API supports both the JSON and XML data serialization formats. The request - format is specified using the Content-Type header and is required for - operations that have a request body. The response format can be specified in requests using - either the Accept header or adding an .xml or .json - extension to the request URI. Note that it is possible for a response to be serialized using - a format different from the request (see example below). If no response format is specified, - JSON is the default. If conflicting formats are specified using both an Accept - header and a query extension, the query extension takes precedence. - - - - - - - - - - - - - - - - - - - - - - - - -
Response Types
FormatAccept HeaderQuery ExtensionDefault
JSONapplication/json.jsonYes
XMLapplication/xml.xmlNo
- - JSON Request with Headers - - - - - - - - - XML Response with Headers - - - - - - - -
-
- Content Compression - Request and response body data my be encoded with gzip compression in order to - accelerate interactive performance of API calls and responses. This is controlled using the - Accept-Encoding header on the request from the client and indicated by the - Content-Encoding header in the server response. Unless the header is - explicitly set, encoding defaults to disabled. - - - - - - - - - - - - - - - - - - - - - -
Compression Headers
Header TypeNameValue
HTTP/1.1 RequestAccept-Encodinggzip
HTTP/1.1 ResponseContent-Encodinggzip
-
-
- Paginated Collections - - To reduce load on the service, list operations will - return a maximum number of items at a time. The - maximum number of items returned is determined by the - Identity provider. To navigate the collection, the - parameters limit and - marker can be set in the URI - (e.g.?limit=100&marker=1234). - The marker parameter is the ID - of the last item in the previous list. Items are - sorted by update time. When an update time is not - available they are sorted by ID. The - limit parameter sets the page - size. Both parameters are optional. If the client - requests a limit beyond that - which is supported by the deployment an overLimit - (413) fault may be thrown. A - marker with an invalid ID will return an itemNotFound - (404) fault. - - - - Paginated collections never return itemNotFound - (404) faults when the - collection is empty — clients should expect - an empty collection. - - - - For convenience, collections contain atom "next" and - "previous" links. The first page in the list will not - contain a "previous" link, the last page in the list - will not contain a "next" link. The following examples - illustrate three pages in a collection of tenants. The - first page was retrieved via a &GET; to - http://identity.api.openstack.org/v2.0/1234/tenants?limit=1. - In these examples, the limit - parameter sets the page size to a single item. - Subsequent "next" and "previous" links will honor the - initial page size. Thus, a client may follow links to - traverse a paginated collection without having to - input the marker parameter. - - - Tenant Collection, First Page: XML - - - - - - Tenant Collection, First Page: JSON - - - - Tenant Collection, Second Page: XML - - - - - - Tenant Collection, Second Page: JSON - - - - Tenant Collection, Last Page: XML - - - - - - Tenant Collection, Last Page: JSON - - - - In the JSON representation, paginated collections contain - a values property that contains the - items in the collections. Links are accessed via the - links property. The approach allows - for extensibility of both the collection members and of - the paginated collection itself. It also allows - collections to be embedded in other objects as illustrated - below. Here, a subset of grups are presented within a - user. Clients must follow the "next" link to continue to - retrive additonal groups belonging to a user. - - - Paginated Groups in a User: XML - - - - - - Paginated Groups in an User: JSON - - -
-
- Versions - - The OpenStack Identity API uses both a URI and a MIME - type versioning scheme. In the URI scheme, the first - element of the path contains the target version - identifier (e.g. https://identity.api.openstack.org/ - v2.0/…). The MIME type versioning scheme uses - HTTP content negotiation where the Accept - or Content-Type headers contains a MIME - type that identifies the version - (application/vnd.openstack.identity-v1.1+xml). A - version MIME type is always linked to a base MIME type - (application/xml or application/json). If conflicting - versions are specified using both an HTTP header and a - URI, the URI takes precedence. - - - Request with MIME type versioning - -GET /tenants HTTP/1.1 -Host: identity.api.openstack.org -Accept: application/vnd.openstack.identity-v1.1+xml -X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb - - - - Request with URI versioning - -GET /v1.1/tenants HTTP/1.1 -Host: identity.api.openstack.org -Accept: application/xml -X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb - - - - - The MIME type versioning approach allows for the - creating of permanent links, because the version - scheme is not specified in the URI path: - https://api.identity.openstack.org/tenants/12234. - - - - If a request is made without a version specified in - the URI or via HTTP headers, then a multiple-choices - response (300) will follow - providing links and MIME types to available versions. - - - Multiple Choices Response: XML - - - - - - Multiple Choices Response: JSON - - - - New features and functionality that do not break - API-compatibility will be introduced in the current - version of the API as extensions (see below) and the - URI and MIME types will remain unchanged. Features or - functionality changes that would necessitate a break - in API-compatibility will require a new version, which - will result in URI and MIME type version being updated - accordingly. When new API versions are released, older - versions will be marked as - DEPRECATED. Providers should work with - developers and partners to ensure there is adequate - time to migrate to the new version before deprecated - versions are discontinued. - - - Your application can programmatically determine - available API versions by performing a &GET; on the - root URL (i.e. with the version and everything to the - right of it truncated) returned from the - authentication system. Note that an Atom - representation of the versions resources is supported - when issuing a request with the Accept - header containing application/atom+xml or by adding a - .atom to the request URI. This allows standard Atom - clients to track version changes. - - - Versions List Request - -GET HTTP/1.1 -Host: identity.api.openstack.org - - - &CODES;200, 203 - &ERROR_CODES; badRequest - (400), identityFault - (500), - serviceUnavailable(503) - &NO_REQUEST; - - Versions List Response: XML - - - - - - Versions List Response: Atom - - - - - - Versions List Response: JSON - - - - You can also obtain additional information about a - specific version by performing a &GET; on the base - version URL - (e.g. https://identity.api.openstack.org/v1.1/). - Version request URLs should always end with a trailing - slash (/). If the slash is omitted, the server may - respond with a 302 - redirection request. Format extensions may be placed - after the slash - (e.g. https://identity.api.openstack.org/v1.1/.xml). Note - that this is a special case that does not hold true - for other API requests. In general, requests such as - /tenants.xml and /tenants/.xml are handled - equivalently. - - - Version Details Request - -GET HTTP/1.1 -Host: identity.api.openstack.org/v1.1/ - - - &CODES;200, 203 - &ERROR_CODES; badRequest - (400), identityFault - (500), - serviceUnavailable(503) - &NO_REQUEST; - - Version Details Response: XML - - - - - - Version Details Response: Atom - - - - - - Version Details Response: JSON - - - - The detailed version response contains pointers to - both a human-readable and a machine-processable - description of the API service. The machine-processable description is written in the Web - Application Description Language (WADL). - - - If there is a discrepancy between the two specifications, the WADL is - authoritative as it contains the most accurate and up-to-date description of the - API service. - -
-
- Extensions - - The OpenStack Identity API is extensible. Extensions - serve two purposes: They allow the introduction of new - features in the API without requiring a version change - and they allow the introduction of vendor specific - niche functionality. Applications can programmatically - determine what extensions are available by performing - a &GET; on the /extensions URI. Note that this is a - versioned request — that is, an extension - available in one API version may not be available in - another. - - - - - Verb - URI - Description - - - - - &GET; - /extensions - Returns a list of available extensions - - - - &CODES;200, 203 - &ERROR_CODES; badRequest - (400), identityFault (500), - serviceUnavailable(503) - &NO_REQUEST; - - Each extension is identified by two unique identifiers, a - namespace and an - alias. Additionally an extension - contains documentation links in various formats. - - - Extensions Response: XML - - - - - - Extensions Response: JSON - - - - Extensions may also be queried individually by their - unique alias. This provides the simplest method of - checking if an extension is available as an unavailable - extension will issue an itemNotFound - (404) response. - - - - - Verb - URI - Description - - - - - &GET; - /extensions/alias - Return details of a single extension - - - - &CODES;200, 203 - &ERROR_CODES; itemNotFound - (404), badRequest - (400), identityFault - (500), - serviceUnavailable(503) - &NO_REQUEST; - - Extension Response: xml - - - - - - Extensions Response: JSON - - - - Extensions may define new data types, parameters, actions, - headers, states, and resources. In XML, additional - elements and attributes may be defined. These elements - must be defined in the extension's namespace. In JSON, the - alias must be used. The volumes element in the and - - is defined in the RS-META namespace. Extended - headers are always prefixed with X- followed - by the alias and a dash: (X-RS-META-HEADER1). - Parameters must be prefixed with the extension alias - followed by a colon. - - - - Applications should be prepared to ignore response - data that contains extension elements. Also, - applications should also verify that an extension is - available before submitting an extended request. - - - - Extended User Response: XML - - - - - - Extended User Response: JSON - - -
-
- Faults - When an error occurs the system will return an HTTP error response code denoting the - type of error. The system will also return additional information about the fault in the - body of the response. - - XML Fault Response - - - - - - JSON Fault Response - - - - - The error code is returned in the body of the response for convenience. The message - section returns a human readable message. The details section is optional and may contain - useful information for tracking down an error (e.g a stack trace). - The root element of the fault (e.g. identityFault) may change depending on the type of error. - The following is an example of an itemNotFound error. - - XML Not Found Fault - - - - - - JSON Not Found Fault - - - - - The following is a list of possible fault types along with their associated error - codes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fault Types
Fault ElementAssociated Error CodeExpected in All Requests
identityFault500, 400 ✓
serviceUnavailable503 ✓
badRequest400 ✓
unauthorized401 ✓
overLimit413 -
userDisabled403 -
forbidden403 -
itemNotFound404 -
tenantConflict409 -
- From an XML schema perspective, all API faults are extensions of the base fault type - identityFault. When working with a system that binds XML to actual classes (such - as JAXB), one should be capable of using identityFault as a “catch-all” if - there's no interest in distinguishing between individual fault types. -
- - - Service API (Client Operations) -
- Overview - The operations described in this chapter allow clients to authenticate and get - access tokens and service endpoints. -
-
- Core Service API Proposal - The following table of calls is proposed as core Keystone APIs - - &URI_REFHEAD; - - - &POST; - /tokens - Authenticate to generate a token. - - - &GET; - /tenants - Get a list of tenants accessible with supplied token. - - - - Any other Service APIs listed in this section will be extensions used for this - reference implementation of Keystone -
- -
- Authenticate - - &URI_REFHEAD; - - - &POST; - /tokens - Authenticate to generate a token. - - - - &CODES;200, 203 - &ERROR_CODES; unauthorized (401), userDisabled - (403), badRequest (400), identityFault - (500), serviceUnavailable(503) - - TenantID is optional and may be used to specify that a - token should be returned that has access to the resources - of that particular tenant. - - - XML Auth Request - - - - - - JSON Auth Request - - - - - - XML Auth Response - - - - - - JSON Auth Response - - - - -
-
- Get Tenants - - &LONG_URI_REFHEAD; - - - &GET; - /tenants - Get a list of tenants. - - - - &CODES;200, 203 - &ERROR_CODES; unauthorized (401), - forbidden(403), overLimit(413), - badRequest (400), identityFault (500), - serviceUnavailable(503) - - The operation returns a list of tenants which the caller has - access to. This call must be authenticated, so a valid token must - be passed in as a header. - - - Tenants Request with Auth Token - - - - - &NO_REQUEST; - - JSON Tenants Response - - - - - - XML Tenants Response - - - - -
- - - - - Admin API (Service Developer Operations) -
- Overview - The operations described in this chapter allow service developers to get and validate - access tokens, manage users, tenants, roles, and service endpoints. -
-
- Core Admin API Proposal - The following table of calls is proposed as core Keystone Admin APIs - -
- Admin Access - Most calls on the Admin API require authentication. The only calls available without authentication are the calls to discover the service (getting version info, WADL contract, dev guide, help, etc…) and the call to authenticate and get a token. - -Authentication is performed by passing in a valid token in the X-Auth-Token header on the request from the client. -Keystone will verify the token has (or belongs to a user that has) the Admin role. - - - See the readme file or administrator guides for how to bootstrap Keystone and create your first administrator. - - - - - - - - - - - - - - - - - -
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
-
- -
- Users - - &LONG_URI_REFHEAD; - - - &PUT; - /users - Create a User. - - - &GET; - /users - Get a list of users. - - - &GET; - /users/userId - Get a user. - - - &PUT; - /users/userId - Update a user. - - - &DELETE; - /users/userId - Delete a user. - - - &PUT; - /users/userId/password - Update a user password. - - - &PUT; - /users/userId/enabled - Enable/Disable user. - - - &PUT; - /users/userId/tenant - Update user tenant. - - - -
-
- Tokens - - &LONG_URI_REFHEAD; - - - &GET; - /tokens/tokenId - Validate a token. - - - &DELETE; - /tokens/tokenId - Revoke an existing token. - - - -
- -
- Tenants - - &LONG_URI_REFHEAD; - - - &GET; - /tenants - Get a list of tenants. - - - &GET; - /tenants/tenantId - Get a tenant. - - - &PUT; - /tenants - Create a tenant. - - - &PUT; - /tenants/tenantId - Update a tenant. - - - &DELETE; - /tenants/tenantId - Delete a tenant. - - - &GET; - /tenants/tenantId/users - Get a tenant's users. - - - - -
- -
- Endpoint Templates and EndPoints - - &LONG_URI_REFHEAD; - - - &GET; - - /endpointTemplates?serviceName=ServiceName - - - Get a list of endpoint templates. - - - - &GET; - - /endpointTemplates/enabled?serviceName=ServiceName - - - Get a list of enabled endpoint templates. - - - - &GET; - - /endpointTemplates/endpointTemplateId - - - Get an endpoint template. - - - - &GET; - - /tenants/tenantId/endpoints - - - Get a list of endpoints for a tenant. - - - - &POST; - - /tenants/tenantId/endpoints - - - Add an endpoint to a tenant. - - - - &DELETE; - - /tenants/tenantId/endpoints/endpointId - - Remove endpoint from a tenant. - - - - -
- -
- Roles - - &LONG_URI_REFHEAD; - - - &GET; - - /roles - - Get a list of roles. - - - - &GET; - - /roles/roleId - - Get a a role. - - - - &GET; - - /users/userId/roleRefs - - - Get a list of roles for a user. - - - - &POST; - - /users/userId/roleRefs - - - Add a role to a user. - - - - &DELETE; - - /users/userId/roleRefs/roleRefId - - Remove a role from a user. - - - - -
- - All other APIs listed in this section will be extensions used for this - reference implementation of Keystone to support user and tenant management -
-
- Token Operations -
- Authenticate - All client operations are supported on the admin API -
-
- Validate Token - - &LONG_URI_REFHEAD; - - - &GET; - /tokens/tokenId?belongsTo=tenantId - Check that a token is valid and that it belongs to a particular user - and return the permissions relevant to a particular client. - - - - &CODES;200, 203 - &ERROR_CODES; unauthorized (401), forbidden - (403), userDisabled(403), - badRequest (400), itemNotFound (404), - identityFault(500), - serviceUnavailable(503) - &NO_REQUEST; - - Valid tokens will exist in the - /tokens/tokenId path and invalid - tokens will not. In other words, a user should expect an - itemNotFound (404) fault for an - invalid token. - - - XML Validate Token Response - - - - - - JSON Validate Token Response - - - - -
-
- Revoke Token - - &LONG_URI_REFHEAD; - - - &DELETE; - /tokens/tokenId - Revoke an existing token. - - - - &CODES;204 - &ERROR_CODES; unauthorized (401), forbidden - (403), userDisabled(403), - badRequest (400), itemNotFound (404), - identityFault(500), - serviceUnavailable(503) - &NO_REQUEST; -
-
-
- Tenant Operations -
- Create a Tenant - - &LONG_URI_REFHEAD; - - - &POST; - /tenants - Create a tenant - - - - &CODES;201 - &ERROR_CODES; unauthorized (401), - forbidden(403), - badRequest (400), identityFault (500), - serviceUnavailable(503) - - XML Tenant Create Request - - - - - - JSON Tenant Create Request - - - - - - XML Tenant Create Response - - - - - - JSON Tenant Create Response - - - - -
-
- Get Tenants - - &LONG_URI_REFHEAD; - - - &GET; - /tenants - Get a list of tenants. - - - - &CODES;200, 203 - &ERROR_CODES; unauthorized (401), - forbidden(403), overLimit(413), - badRequest (400), identityFault (500), - serviceUnavailable(503) - - The operation returns a list of tenants. The list may be - filtered to return only those tenants which the caller has - access to. - - &NO_REQUEST; - - XML Tenants Response - - - - - - JSON Tenants Response - - - - -
-
- Get a Tenant - - &LONG_URI_REFHEAD; - - - &GET; - /tenants/tenantId - Get a tenant. - - - - &CODES;200, 203 - &ERROR_CODES; unauthorized (401), - forbidden(403), itemNotFound(404), - badRequest (400), identityFault (500), - serviceUnavailable(503) - &NO_REQUEST; - - XML Tenant Response - - - - - - JSON Tenant Response - - - - -
-
- Update a Tenant - - &LONG_URI_REFHEAD; - - - &PUT; - /tenants/tenantId - Update a tenant. - - - - &CODES;200 - &ERROR_CODES; unauthorized (401), - forbidden(403), itemNotFound(404), - badRequest (400), identityFault (500), - serviceUnavailable(503) - - XML Tenant Update Request - - - - - - JSON Tenant Update Request - - - - - - XML Tenant Update Response - - - - - - JSON Tenant Update Response - - - - -
-
- Delete a Tenant - - &LONG_URI_REFHEAD; - - - &DELETE; - /tenants/tenantId - Delete a Tenant. - - - - &CODES;204 - &ERROR_CODES; unauthorized (401), badRequest - (400), forbidden (403), itemNotFound - (404), identityFault (500), - serviceUnavailable(503) - &NO_REQUEST; -
-
-
- Endpoint Templates and Endpoints -
- Get Endpoint Templates - - &LONG_URI_REFHEAD; - - - &GET; - - /endpointTemplates?serviceName=ServiceName - - - Get a list of endpoint templates.Endpoint templates that have global set to true are - automatically available for every tenant. - - - - &GET; - - /endpointTemplates/enabled?serviceName=ServiceName - - - Get a list of enabled endpoint templates.Endpoint templates that have global set to true are - automatically available for every tenant. - - - - - - - &CODES; 200, - 203 - - - &ERROR_CODES; - unauthorized (401), - forbidden (403), - badRequest (400), - authFault (500), - serviceUnavailable (503) - - &NO_REQUEST; - - Endpoint Templates Response: XML - - - - - - Endpoint Templates Response: JSON - - - - -
-
- Get Endpoint Template - - &LONG_URI_REFHEAD; - - - &GET; - - /endpointTemplates/endpointTemplateId - - - Get an endpoint template. - - - - - - &CODES; 200, - 203 - - - &ERROR_CODES; - unauthorized (401), - forbidden (403), - badRequest (400), - authFault (500), - serviceUnavailable (503) - - &NO_REQUEST; - - Endpoint Template Response: XML - - - - - - - Endpoint Template Response: JSON - - - - - -
-
- Get Endpoints for a Tenant - - &LONG_URI_REFHEAD; - - - &GET; - - /tenants/tenantId/endpoints - - - Get a list of endpoints for a tenant. - - - - - - &CODES; 200, - 203 - - - &ERROR_CODES; - unauthorized (401), - forbidden (403), - badRequest (400), - authFault (500), - serviceUnavailable (503) - - &NO_REQUEST; - - Endpoints Response: XML - - - - - - Endpoints Response: JSON - - - - -
-
- Add Endpoint to a Tenant. - - &LONG_URI_REFHEAD; - - - &POST; - - /tenants/tenantId/endpoints - - - Add an endpoint to a tenant. - - - - - - &CODES; - 201 - - - &ERROR_CODES; - unauthorized (401), - forbidden (403), - badRequest (400), - itemNotFound (404), - authFault (500), - serviceUnavailable (503) - - - Expect a badRequest (400) response if a disabled endpoint is added or if the endpoint had been previously added. - - - Add Endpoint Request: XML - - - - - - - Add Endpoint Request: JSON - - - - - -
-
- Remove Endpoints from a Tenant - - &LONG_URI_REFHEAD; - - - &DELETE; - - /tenants/tenantId/endpoints/endpointId - - Remove endpoint from a tenant. - - - - - - &CODES; - 204 - - - &ERROR_CODES; - unauthorized (401), - forbidden (403), - badRequest (400), - itemNotFound (404), - authFault (500), - serviceUnavailable (503) - - &NO_REQUEST; -
-
- -
- Roles -
- Get roles - - &LONG_URI_REFHEAD; - - - &GET; - - /roles - - Get a list of roles. - - - - - - &CODES; 200, - 203 - - - &ERROR_CODES; - unauthorized (401), - forbidden (403), - badRequest (400), - authFault (500), - serviceUnavailable (503) - - &NO_REQUEST; - - Roles Response: XML - - - - - - Roles Response: JSON - - - - -
-
- Get Role - - &LONG_URI_REFHEAD; - - - &GET; - - /roles/roleId - - - Get a role. - - - - - - &CODES; 200, - 203 - - - &ERROR_CODES; - unauthorized (401), - forbidden (403), - badRequest (400), - authFault (500), - serviceUnavailable (503) - - &NO_REQUEST; - - Role Response: XML - - - - - - - Role Response: JSON - - - - - -
-
- Get roles for a User - - &LONG_URI_REFHEAD; - - - &GET; - - /users/userId/roleRefs - - - Get a list of roles for a user. - - - - - - &CODES; 200, - 203 - - - &ERROR_CODES; - unauthorized (401), - forbidden (403), - badRequest (400), - authFault (500), - serviceUnavailable (503) - - &NO_REQUEST; - - Role Refs Response: XML - - - - - - Role Refs Response: JSON - - - - -
-
- Add Role to a User - - &LONG_URI_REFHEAD; - - - &POST; - - /users/userId/roleRefs - - - Add a role to a user. - - - - - - &CODES; - 201 - - - &ERROR_CODES; - unauthorized (401), - forbidden (403), - badRequest (400), - itemNotFound (404), - authFault (500), - serviceUnavailable (503) - - - Add Role Request: XML - - - - - - - Add Role Request: JSON - - - - - -
-
- Remove roles from a User - - &LONG_URI_REFHEAD; - - - &DELETE; - - /users/userId/roleRefs/roleRefId - - Remove a role from a user. - - - - - - &CODES; - 204 - - - &ERROR_CODES; - unauthorized (401), - forbidden (403), - badRequest (400), - itemNotFound (404), - authFault (500), - serviceUnavailable (503) - - &NO_REQUEST; -
-
- - - - Appendix -
- Rackspace Extension Proposal -
- Concepts - - The concepts that are specific to Rackspace extensions are: - -
- Group - - Groups may be used to organize and assign - privileges to a group of related users. For example, an operator - may create a "delinquent" group, which will assign limited - privileges to users who have past due bills. - -
-
- - The following table of calls is proposed as Rackspace-specific - extensions for Keystone APIs in this version (2.0) - -
- Global Groups - - &LONG_URI_REFHEAD; - - - &PUT; - /groups - Create a global group. - - - &GET; - /groups - Get a list of global groups. - - - &GET; - /groups/groupId - Get a global group. - - - &PUT; - /groups/groupId - Update a global group. - - - &DELETE; - /groups/groupId - Delete a global group. - - - &GET; - /groups/groupId/users - Get a list of users of a global group. - - - &PUT; - /groups/groupId/users/userId - Add user to a global group. - - - &DELETE; - /groups/groupId/users/userId - Delete user from a global group. - - - -
-
- Tenant Groups - - &LONG_URI_REFHEAD; - - - &GET; - /tenants/tenantId/groups - Get a list of tenant groups. - - - &POST; - /tenants/tenantId/groups - Create a tenant group. - - - &GET; - /tenants/tenantId/groups/groupId - Get a tenant group with the specified id. - - - &PUT; - /tenants/tenantId/groups/groupId - Update a tenant group. - - - &GET; - /tenants/tenantId/groups/groupId/users - List tenant group users. - - - &PUT; - /tenants/tenantId/groups/groupId/users/userId - Add a user to a tenant group. - - - &DELETE; - /tenants/tenantId/groups/groupId/users/userId - Remove user from tenant group. - - - -
- -
- - - diff --git a/doc/guide/src/docbkx/img/Check_mark_23x20_02.svg b/doc/guide/src/docbkx/img/Check_mark_23x20_02.svg deleted file mode 100644 index 3051a2f937..0000000000 --- a/doc/guide/src/docbkx/img/Check_mark_23x20_02.svg +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - - image/svg+xml - - - - - - - - diff --git a/doc/guide/src/docbkx/samples/auth.json b/doc/guide/src/docbkx/samples/auth.json deleted file mode 100644 index c74dcb2b4f..0000000000 --- a/doc/guide/src/docbkx/samples/auth.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "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/doc/guide/src/docbkx/samples/auth.xml b/doc/guide/src/docbkx/samples/auth.xml deleted file mode 100644 index 6d90c0642f..0000000000 --- a/doc/guide/src/docbkx/samples/auth.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/doc/guide/src/docbkx/samples/auth_credentials.json b/doc/guide/src/docbkx/samples/auth_credentials.json deleted file mode 100644 index a886351aec..0000000000 --- a/doc/guide/src/docbkx/samples/auth_credentials.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "passwordCredentials":{ - "username":"test_user", - "password":"a86850deb2742ec3cb41518e26aa2d89", - "tenantId":"77654" - } -} diff --git a/doc/guide/src/docbkx/samples/auth_credentials.xml b/doc/guide/src/docbkx/samples/auth_credentials.xml deleted file mode 100644 index 56bd91d6fc..0000000000 --- a/doc/guide/src/docbkx/samples/auth_credentials.xml +++ /dev/null @@ -1,5 +0,0 @@ - - diff --git a/doc/guide/src/docbkx/samples/choices.json b/doc/guide/src/docbkx/samples/choices.json deleted file mode 100644 index 9beecef082..0000000000 --- a/doc/guide/src/docbkx/samples/choices.json +++ /dev/null @@ -1,72 +0,0 @@ -{ - "choices":{ - "values":[ - { - "id":"v1.0", - "status":"DEPRECATED", - "links":[ - { - "rel":"self", - "href":"http://identity.api.openstack.org/v2.0" - } - ], - "media-types":{ - "values":[ - { - "base":"application/xml", - "type":"application/vnd.openstack.identity-v1.0+xml" - }, - { - "base":"application/json", - "type":"application/vnd.openstack.identity-v1.0+json" - } - ] - } - }, - { - "id":"v1.1", - "status":"CURRENT", - "links":[ - { - "rel":"self", - "href":"http://identity.api.openstack.org/v1.1" - } - ], - "media-types":{ - "values":[ - { - "base":"application/xml", - "type":"application/vnd.openstack.identity-v1.1+xml" - }, - { - "base":"application/json", - "type":"application/vnd.openstack.identity-v1.1+json" - } - ] - } - }, - { - "id":"v2.0", - "status":"BETA", - "links":[ - { - "rel":"self", - "href":"http://identity.api.openstack.org/v2.0" - } - ], - "media-types":{ - "values":[ - { - "base":"application/xml", - "type":"application/vnd.openstack.identity-v2.0+xml" - }, - { - "base":"application/json", - "type":"application/vnd.openstack.identity-v2.0+json" - } - ] - } - } - ] - } -} diff --git a/doc/guide/src/docbkx/samples/choices.xml b/doc/guide/src/docbkx/samples/choices.xml deleted file mode 100644 index 134c9d009a..0000000000 --- a/doc/guide/src/docbkx/samples/choices.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/guide/src/docbkx/samples/endpoint.json b/doc/guide/src/docbkx/samples/endpoint.json deleted file mode 100644 index 8ca1f0998a..0000000000 --- a/doc/guide/src/docbkx/samples/endpoint.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "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 deleted file mode 100644 index 8ff1e48c6f..0000000000 --- a/doc/guide/src/docbkx/samples/endpoint.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - diff --git a/doc/guide/src/docbkx/samples/endpointTemplate.json b/doc/guide/src/docbkx/samples/endpointTemplate.json deleted file mode 100644 index 2ed4917f25..0000000000 --- a/doc/guide/src/docbkx/samples/endpointTemplate.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "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 deleted file mode 100644 index 31f4eaeb7a..0000000000 --- a/doc/guide/src/docbkx/samples/endpointTemplate.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - diff --git a/doc/guide/src/docbkx/samples/endpointTemplates.json b/doc/guide/src/docbkx/samples/endpointTemplates.json deleted file mode 100644 index 488e8c5dea..0000000000 --- a/doc/guide/src/docbkx/samples/endpointTemplates.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "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 deleted file mode 100644 index 60a9d2e4fa..0000000000 --- a/doc/guide/src/docbkx/samples/endpointTemplates.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - - diff --git a/doc/guide/src/docbkx/samples/endpoints.json b/doc/guide/src/docbkx/samples/endpoints.json deleted file mode 100644 index f8c79aa2c3..0000000000 --- a/doc/guide/src/docbkx/samples/endpoints.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "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 deleted file mode 100644 index 3fa46c4c6a..0000000000 --- a/doc/guide/src/docbkx/samples/endpoints.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - - - - diff --git a/doc/guide/src/docbkx/samples/ext-getuser.json b/doc/guide/src/docbkx/samples/ext-getuser.json deleted file mode 100644 index 34068f549f..0000000000 --- a/doc/guide/src/docbkx/samples/ext-getuser.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "user":{ - "groups":{ - "values":[ - { - "tenantId":"1234", - "id":"Admin" - } - ] - }, - "id":"jqsmith", - "tenantId":"1234", - "email":"john.smith@example.org", - "enabled":true, - "RS-META:metadata":{ - "values":{ - "MetaKey1":"MetaValue1", - "MetaKey2":"MetaValue2" - } - } - } -} diff --git a/doc/guide/src/docbkx/samples/ext-getuser.xml b/doc/guide/src/docbkx/samples/ext-getuser.xml deleted file mode 100644 index bf0a9c6e96..0000000000 --- a/doc/guide/src/docbkx/samples/ext-getuser.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - MetaValue1 - MetaValue2 - - diff --git a/doc/guide/src/docbkx/samples/extension.json b/doc/guide/src/docbkx/samples/extension.json deleted file mode 100644 index 7477391567..0000000000 --- a/doc/guide/src/docbkx/samples/extension.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "extension":{ - "name":"User Metadata Extension", - "namespace":"http://docs.rackspacecloud.com/identity/api/ext/meta/v2.0", - "alias":"RS-META", - "updated":"2011-01-12T11:22:33-06:00", - "description":"Allows associating arbritrary metadata with a user.", - "links":[ - { - "rel":"describedby", - "type":"application/pdf", - "href":"http://docs.rackspacecloud.com/identity/api/ext/identity-meta-20111201.pdf" - }, - { - "rel":"describedby", - "type":"application/vnd.sun.wadl+xml", - "href":"http://docs.rackspacecloud.com/identity/api/ext/identity-cbs.wadl" - } - ] - } -} diff --git a/doc/guide/src/docbkx/samples/extension.xml b/doc/guide/src/docbkx/samples/extension.xml deleted file mode 100644 index 056d7e9607..0000000000 --- a/doc/guide/src/docbkx/samples/extension.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - Allows associating arbritrary metadata with a user. - - - - - - - - diff --git a/doc/guide/src/docbkx/samples/extensions.json b/doc/guide/src/docbkx/samples/extensions.json deleted file mode 100644 index 53d8d50873..0000000000 --- a/doc/guide/src/docbkx/samples/extensions.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "extensions":{ - "values":[ - { - "name":"Reset Password Extension", - "namespace":"http://docs.rackspacecloud.com/identity/api/ext/rpe/v2.0", - "alias":"RS-RPE", - "updated":"2011-01-22T13:25:27-06:00", - "description":"Adds the capability to reset a user's password. The user is emailed when the password has been reset.", - "links":[ - { - "rel":"describedby", - "type":"application/pdf", - "href":"http://docs.rackspacecloud.com/identity/api/ext/identity-rpe-20111111.pdf" - }, - { - "rel":"describedby", - "type":"application/vnd.sun.wadl+xml", - "href":"http://docs.rackspacecloud.com/identity/api/ext/identity-rpe.wadl" - } - ] - }, - { - "name":"User Metadata Extension", - "namespace":"http://docs.rackspacecloud.com/identity/api/ext/meta/v2.0", - "alias":"RS-META", - "updated":"2011-01-12T11:22:33-06:00", - "description":"Allows associating arbritrary metadata with a user.", - "links":[ - { - "rel":"describedby", - "type":"application/pdf", - "href":"http://docs.rackspacecloud.com/identity/api/ext/identity-meta-20111201.pdf" - }, - { - "rel":"describedby", - "type":"application/vnd.sun.wadl+xml", - "href":"http://docs.rackspacecloud.com/identity/api/ext/identity-meta.wadl" - } - ] - } - ] - } -} diff --git a/doc/guide/src/docbkx/samples/extensions.xml b/doc/guide/src/docbkx/samples/extensions.xml deleted file mode 100644 index c11b06d74a..0000000000 --- a/doc/guide/src/docbkx/samples/extensions.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - Adds the capability to reset a user's password. The user is - emailed when the password has been reset. - - - - - - - - Allows associating arbritrary metadata with a user. - - - - - - diff --git a/doc/guide/src/docbkx/samples/getuser-1.json b/doc/guide/src/docbkx/samples/getuser-1.json deleted file mode 100644 index b0f6dc9543..0000000000 --- a/doc/guide/src/docbkx/samples/getuser-1.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "user":{ - "groups":{ - "values":[ - { - "tenantId":"1234", - "id":"Admin" - }, - { - "tenantId":"1234", - "id":"DBUser" - }, - { - "id":"Super" - } - ], - "links":[ - { - "rel":"next", - "href":"http://identity.api.openstack.org/v2.0/tenants/1234/users/jqsmith/groups?marker=Super" - } - ] - }, - "id":"jqsmith", - "tenantId":"1234", - "email":"john.smith@example.org", - "enabled":true - } -} diff --git a/doc/guide/src/docbkx/samples/getuser-1.xml b/doc/guide/src/docbkx/samples/getuser-1.xml deleted file mode 100644 index cc0f5fc663..0000000000 --- a/doc/guide/src/docbkx/samples/getuser-1.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - diff --git a/doc/guide/src/docbkx/samples/group.json b/doc/guide/src/docbkx/samples/group.json deleted file mode 100644 index 4e4fdc5e28..0000000000 --- a/doc/guide/src/docbkx/samples/group.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "group":{ - "id":"test_global_group", - "description":"A description ..." - } -} diff --git a/doc/guide/src/docbkx/samples/group.xml b/doc/guide/src/docbkx/samples/group.xml deleted file mode 100644 index 0f285307bf..0000000000 --- a/doc/guide/src/docbkx/samples/group.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - A Description of the group - diff --git a/doc/guide/src/docbkx/samples/groups.json b/doc/guide/src/docbkx/samples/groups.json deleted file mode 100644 index 6d565eb653..0000000000 --- a/doc/guide/src/docbkx/samples/groups.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "groups":{ - "values":[ - { - "id":"test_global_group_add", - "description":"A description ..." - } - ], - "links":[ - - ] - } -} diff --git a/doc/guide/src/docbkx/samples/groups.xml b/doc/guide/src/docbkx/samples/groups.xml deleted file mode 100644 index a429fdb3a4..0000000000 --- a/doc/guide/src/docbkx/samples/groups.xml +++ /dev/null @@ -1,5 +0,0 @@ - - - A Description of the group - - diff --git a/doc/guide/src/docbkx/samples/identity_fault.json b/doc/guide/src/docbkx/samples/identity_fault.json deleted file mode 100644 index 1aab06dc29..0000000000 --- a/doc/guide/src/docbkx/samples/identity_fault.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "identityFault":{ - "message":"Fault", - "details":"Error Details...", - "code":500 - } -} diff --git a/doc/guide/src/docbkx/samples/identity_fault.xml b/doc/guide/src/docbkx/samples/identity_fault.xml deleted file mode 100644 index 6787af21c6..0000000000 --- a/doc/guide/src/docbkx/samples/identity_fault.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - Fault -
Error Details...
- diff --git a/doc/guide/src/docbkx/samples/item_not_found.json b/doc/guide/src/docbkx/samples/item_not_found.json deleted file mode 100644 index 248ed14664..0000000000 --- a/doc/guide/src/docbkx/samples/item_not_found.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "itemNotFound":{ - "message":"Item not found.", - "details":"Error Details...", - "code":404 - } -} diff --git a/doc/guide/src/docbkx/samples/item_not_found.xml b/doc/guide/src/docbkx/samples/item_not_found.xml deleted file mode 100644 index 3f78b498f0..0000000000 --- a/doc/guide/src/docbkx/samples/item_not_found.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - Item not found. -
Error Details...
- diff --git a/doc/guide/src/docbkx/samples/role.json b/doc/guide/src/docbkx/samples/role.json deleted file mode 100644 index 248ed14664..0000000000 --- a/doc/guide/src/docbkx/samples/role.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "itemNotFound":{ - "message":"Item not found.", - "details":"Error Details...", - "code":404 - } -} diff --git a/doc/guide/src/docbkx/samples/role.xml b/doc/guide/src/docbkx/samples/role.xml deleted file mode 100644 index 48fe20d822..0000000000 --- a/doc/guide/src/docbkx/samples/role.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - diff --git a/doc/guide/src/docbkx/samples/roleRef.json b/doc/guide/src/docbkx/samples/roleRef.json deleted file mode 100644 index faa742837f..0000000000 --- a/doc/guide/src/docbkx/samples/roleRef.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "roleRef":{ - "id":1, - "roleId":"admin", - "tenantId":"one" - } -} diff --git a/doc/guide/src/docbkx/samples/roleRef.xml b/doc/guide/src/docbkx/samples/roleRef.xml deleted file mode 100644 index 29115ee2ac..0000000000 --- a/doc/guide/src/docbkx/samples/roleRef.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - diff --git a/doc/guide/src/docbkx/samples/roleRefs.json b/doc/guide/src/docbkx/samples/roleRefs.json deleted file mode 100644 index 34e391f505..0000000000 --- a/doc/guide/src/docbkx/samples/roleRefs.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "roleRefs":[ - { - "id":1, - "roleId":"admin", - "tenantId":"one" - }, - { - "id":2, - "roleId":"test", - "tenantId":"two" - } - ] -} diff --git a/doc/guide/src/docbkx/samples/roleRefs.xml b/doc/guide/src/docbkx/samples/roleRefs.xml deleted file mode 100644 index bd7ee983cd..0000000000 --- a/doc/guide/src/docbkx/samples/roleRefs.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - diff --git a/doc/guide/src/docbkx/samples/roles.json b/doc/guide/src/docbkx/samples/roles.json deleted file mode 100644 index 4f1428e4d4..0000000000 --- a/doc/guide/src/docbkx/samples/roles.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "roles":[ - { - "id":"Admin", - "description":"All access" - }, - { - "id":"Guest", - "description":"Guest Access" - } - ] -} diff --git a/doc/guide/src/docbkx/samples/roles.xml b/doc/guide/src/docbkx/samples/roles.xml deleted file mode 100644 index bf128ff4e0..0000000000 --- a/doc/guide/src/docbkx/samples/roles.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/doc/guide/src/docbkx/samples/samplerequestheader.json b/doc/guide/src/docbkx/samples/samplerequestheader.json deleted file mode 100644 index 5641d8744c..0000000000 --- a/doc/guide/src/docbkx/samples/samplerequestheader.json +++ /dev/null @@ -1,4 +0,0 @@ -POST /v2.0/tokens HTTP/1.1 -Host: identity.api.openstack.org -Content-Type: application/json -Accept: application/xml \ No newline at end of file diff --git a/doc/guide/src/docbkx/samples/sampleresponseheader.json b/doc/guide/src/docbkx/samples/sampleresponseheader.json deleted file mode 100644 index aee1205a34..0000000000 --- a/doc/guide/src/docbkx/samples/sampleresponseheader.json +++ /dev/null @@ -1,4 +0,0 @@ -HTTP/1.1 200 OKAY -Date: Mon, 12 Nov 2010 15:55:01 GMT -Content-Length: -Content-Type: application/xml; charset=UTF-8 \ No newline at end of file diff --git a/doc/guide/src/docbkx/samples/tenant.json b/doc/guide/src/docbkx/samples/tenant.json deleted file mode 100644 index cf6ca37053..0000000000 --- a/doc/guide/src/docbkx/samples/tenant.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "tenant":{ - "id":"1234", - "description":"A description ...", - "enabled":true - } -} diff --git a/doc/guide/src/docbkx/samples/tenant.xml b/doc/guide/src/docbkx/samples/tenant.xml deleted file mode 100644 index 83210f87b5..0000000000 --- a/doc/guide/src/docbkx/samples/tenant.xml +++ /dev/null @@ -1,5 +0,0 @@ - - - A description... - diff --git a/doc/guide/src/docbkx/samples/tenantlock.json b/doc/guide/src/docbkx/samples/tenantlock.json deleted file mode 100644 index a0f5b138a1..0000000000 --- a/doc/guide/src/docbkx/samples/tenantlock.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "tenant":{ - "description":"A NEW description..." - } -} diff --git a/doc/guide/src/docbkx/samples/tenantlock.xml b/doc/guide/src/docbkx/samples/tenantlock.xml deleted file mode 100644 index 06a68a839f..0000000000 --- a/doc/guide/src/docbkx/samples/tenantlock.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - A NEW description... - diff --git a/doc/guide/src/docbkx/samples/tenants-1.json b/doc/guide/src/docbkx/samples/tenants-1.json deleted file mode 100644 index 67f16deb15..0000000000 --- a/doc/guide/src/docbkx/samples/tenants-1.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "tenants":{ - "values":[ - { - "id":"1234", - "description":"A description ...", - "enabled":true - } - ], - "links":[ - { - "rel":"next", - "href":"http://identity.api.openstack.org/v2.0/tenants?limit=1&marker=1234" - } - ] - } -} diff --git a/doc/guide/src/docbkx/samples/tenants-1.xml b/doc/guide/src/docbkx/samples/tenants-1.xml deleted file mode 100644 index 18fcbfd345..0000000000 --- a/doc/guide/src/docbkx/samples/tenants-1.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - A description... - - diff --git a/doc/guide/src/docbkx/samples/tenants-2.json b/doc/guide/src/docbkx/samples/tenants-2.json deleted file mode 100644 index cc0e9f0323..0000000000 --- a/doc/guide/src/docbkx/samples/tenants-2.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "tenants":{ - "values":[ - { - "id":"3645", - "description":"A description ...", - "enabled":true - } - ], - "links":[ - { - "rel":"next", - "href":"http://identity.api.openstack.org/v2.0/tenants?limit=1&marker=3645" - }, - { - "rel":"previous", - "href":"http://identity.api.openstack.org/v2.0/tenants?limit=1" - } - ] - } -} diff --git a/doc/guide/src/docbkx/samples/tenants-2.xml b/doc/guide/src/docbkx/samples/tenants-2.xml deleted file mode 100644 index 4ad53477fd..0000000000 --- a/doc/guide/src/docbkx/samples/tenants-2.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - A description... - - - diff --git a/doc/guide/src/docbkx/samples/tenants-3.json b/doc/guide/src/docbkx/samples/tenants-3.json deleted file mode 100644 index eb0ed80382..0000000000 --- a/doc/guide/src/docbkx/samples/tenants-3.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "tenants":{ - "values":[ - { - "id":"9999", - "description":"A description ...", - "enabled":true - } - ], - "links":[ - { - "rel":"previous", - "href":"http://identity.api.openstack.org/v2.0/tenants?limit=1&marker=1234" - } - ] - } -} diff --git a/doc/guide/src/docbkx/samples/tenants-3.xml b/doc/guide/src/docbkx/samples/tenants-3.xml deleted file mode 100644 index 7bbd88a760..0000000000 --- a/doc/guide/src/docbkx/samples/tenants-3.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - A description... - - - diff --git a/doc/guide/src/docbkx/samples/tenants-request.txt b/doc/guide/src/docbkx/samples/tenants-request.txt deleted file mode 100644 index 9dbf85e5d0..0000000000 --- a/doc/guide/src/docbkx/samples/tenants-request.txt +++ /dev/null @@ -1,5 +0,0 @@ -GET /v2.0/tenants HTTP/1.1 -Host: identity.api.openstack.org -Content-Type: application/json -X-Auth-Token: fa8426a0-8eaf-4d22-8e13-7c1b16a9370c -Accept: application/json \ No newline at end of file diff --git a/doc/guide/src/docbkx/samples/tenants.json b/doc/guide/src/docbkx/samples/tenants.json deleted file mode 100644 index 7077a2da65..0000000000 --- a/doc/guide/src/docbkx/samples/tenants.json +++ /dev/null @@ -1,21 +0,0 @@ -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 -Content-Length: 100 -Date: Sun, 1 Jan 2011 9:00:00 GMT - -{ - "tenants":{ - "values":[ - { - "id":"1234", - "description":"A description ...", - "enabled":true - }, - { - "id":"3456", - "description":"A description ...", - "enabled":true - } - ] - } -} \ No newline at end of file diff --git a/doc/guide/src/docbkx/samples/tenants.xml b/doc/guide/src/docbkx/samples/tenants.xml deleted file mode 100644 index 2a9e9c3b5c..0000000000 --- a/doc/guide/src/docbkx/samples/tenants.xml +++ /dev/null @@ -1,14 +0,0 @@ -HTTP/1.1 200 OK -Content-Type: application/xml; charset=UTF-8 -Content-Length: 200 -Date: Sun, 1 Jan 2011 9:00:00 GMT - - - - - A description... - - - A description... - - diff --git a/doc/guide/src/docbkx/samples/updatedtenant.json b/doc/guide/src/docbkx/samples/updatedtenant.json deleted file mode 100644 index 9349c90ff2..0000000000 --- a/doc/guide/src/docbkx/samples/updatedtenant.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "tenant":{ - "id":"1234", - "description":"A NEW description...", - "enabled":true - } -} diff --git a/doc/guide/src/docbkx/samples/updatedtenant.xml b/doc/guide/src/docbkx/samples/updatedtenant.xml deleted file mode 100644 index 51999a4d5d..0000000000 --- a/doc/guide/src/docbkx/samples/updatedtenant.xml +++ /dev/null @@ -1,5 +0,0 @@ - - - A NEW description... - diff --git a/doc/guide/src/docbkx/samples/validatetoken.json b/doc/guide/src/docbkx/samples/validatetoken.json deleted file mode 100644 index 989d28ff00..0000000000 --- a/doc/guide/src/docbkx/samples/validatetoken.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "auth":{ - "token":{ - "expires":"2010-11-01T03:32:15-05:00", - "id":"ab48a9efdfedb23ty3494", - "tenantId":"1234" - }, - "user":{ - "username":"jqsmith", - "roleRefs":[ - { - "roleId":"Admin", - "id":1, - "tenantId":"one" - } - ], - "tenantId":"1234" - } - } -} diff --git a/doc/guide/src/docbkx/samples/validatetoken.xml b/doc/guide/src/docbkx/samples/validatetoken.xml deleted file mode 100644 index 18f2680248..0000000000 --- a/doc/guide/src/docbkx/samples/validatetoken.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - diff --git a/doc/guide/src/docbkx/samples/version-atom.xml b/doc/guide/src/docbkx/samples/version-atom.xml deleted file mode 100644 index 004a544440..0000000000 --- a/doc/guide/src/docbkx/samples/version-atom.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - About This Version - 2011-01-21T11:33:21-06:00 - http://identity.api.openstack.org/v2.0/ - OpenStackhttp://www.openstack.org/ - - - http://identity.api.openstack.org/v2.0/ - Version v2.0 - 2011-01-21T11:33:21-06:00 - - - - Version v2.0 CURRENT (2011-01-21T11:33:21-06:00) - - diff --git a/doc/guide/src/docbkx/samples/version.json b/doc/guide/src/docbkx/samples/version.json deleted file mode 100644 index d204cabb96..0000000000 --- a/doc/guide/src/docbkx/samples/version.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "version":{ - "id":"v2.0", - "status":"CURRENT", - "updated":"2011-01-21T11:33:21-06:00", - "links":[ - { - "rel":"self", - "href":"http://identity.api.openstack.org/v2.0/" - }, - { - "rel":"describedby", - "type":"application/pdf", - "href":"http://docs.rackspacecloud.com/identity/api/v2.0/identity-devguide-20110125.pdf" - }, - { - "rel":"describedby", - "type":"application/vnd.sun.wadl+xml", - "href":"http://docs.rackspacecloud.com/identity/api/v2.0/application.wadl" - } - ], - "media-types":[ - { - "base":"application/xml", - "type":"application/vnd.openstack.identity-v2.0+xml" - }, - { - "base":"application/json", - "type":"application/vnd.openstack.identity-v2.0+json" - } - ] - } -} diff --git a/doc/guide/src/docbkx/samples/version.xml b/doc/guide/src/docbkx/samples/version.xml deleted file mode 100644 index 0e8845045c..0000000000 --- a/doc/guide/src/docbkx/samples/version.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - - - - - - - - - diff --git a/doc/guide/src/docbkx/samples/versions-atom.xml b/doc/guide/src/docbkx/samples/versions-atom.xml deleted file mode 100644 index 67783e8ee3..0000000000 --- a/doc/guide/src/docbkx/samples/versions-atom.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - Available API Versions - 2010-12-12T18:30:02.25Z - http://identity.api.openstack.org/ - Rackspacehttp://www.rackspace.com/ - - - http://identity.api.openstack.org/v2.0/ - Version v2.0 - 2011-05-27T20:22:02.25Z - - Version v2.1 CURRENT (2011-05-27T20:22:02.25Z) - - - http://identity.api.openstack.org/v1.1/ - Version v1.1 - 2010-12-12T18:30:02.25Z - - Version v1.1 CURRENT (2010-12-12T18:30:02.25Z) - - - http://identity.api.openstack.org/v1.0/ - Version v1.0 - 2009-10-09T11:30:00Z - - Version v1.0 DEPRECATED (2009-10-09T11:30:00Z) - - diff --git a/doc/guide/src/docbkx/samples/versions.json b/doc/guide/src/docbkx/samples/versions.json deleted file mode 100644 index b7ac02ddcf..0000000000 --- a/doc/guide/src/docbkx/samples/versions.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "versions":{ - "values":[ - { - "id":"v1.0", - "status":"DEPRECATED", - "updated":"2009-10-09T11:30:00Z", - "links":[ - { - "rel":"self", - "href":"http://identity.api.openstack.org/v1.0/" - } - ] - }, - { - "id":"v1.1", - "status":"CURRENT", - "updated":"2010-12-12T18:30:02.25Z", - "links":[ - { - "rel":"self", - "href":"http://identity.api.openstack.org/v1.1/" - } - ] - }, - { - "id":"v2.0", - "status":"BETA", - "updated":"2011-05-27T20:22:02.25Z", - "links":[ - { - "rel":"self", - "href":"http://identity.api.openstack.org/v2.0/" - } - ] - } - ] - } -} diff --git a/doc/guide/src/docbkx/samples/versions.xml b/doc/guide/src/docbkx/samples/versions.xml deleted file mode 100644 index df55b106ba..0000000000 --- a/doc/guide/src/docbkx/samples/versions.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/doc/guide/src/docbkx/xsd/api-common.xsd b/doc/guide/src/docbkx/xsd/api-common.xsd deleted file mode 100644 index 5e8ebeda2a..0000000000 --- a/doc/guide/src/docbkx/xsd/api-common.xsd +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - - - Open Stack Common API Schema Types 1.0 - - - - - -

- This is the main index XML Schema document - for Common API Schema Types Version 1.0. -

- - - - - -

- Types related to extensions. -

- - - - - - -

- Types related to API version details. -

- - - - diff --git a/doc/guide/src/docbkx/xsd/api.xsd b/doc/guide/src/docbkx/xsd/api.xsd deleted file mode 100755 index 14d3ae8ed2..0000000000 --- a/doc/guide/src/docbkx/xsd/api.xsd +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - - - diff --git a/doc/guide/src/docbkx/xsd/atom/atom.xsd b/doc/guide/src/docbkx/xsd/atom/atom.xsd deleted file mode 100644 index c515c497da..0000000000 --- a/doc/guide/src/docbkx/xsd/atom/atom.xsd +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - See section 3.4 of the ATOM RFC RFC4287 - - - - - - - TODO(Jorge) - - - - - - - - TODO(Jorge) - - - - - - - - TODO(Jorge) - - - - - - - - TODO(Jorge) - - - - - - - - TODO(Jorge) - - - - - - - - diff --git a/doc/guide/src/docbkx/xsd/atom/xml.xsd b/doc/guide/src/docbkx/xsd/atom/xml.xsd deleted file mode 100644 index aea7d0db0a..0000000000 --- a/doc/guide/src/docbkx/xsd/atom/xml.xsd +++ /dev/null @@ -1,287 +0,0 @@ - - - - - - -
-

About the XML namespace

- -
-

- This schema document describes the XML namespace, in a form - suitable for import by other schema documents. -

-

- See - http://www.w3.org/XML/1998/namespace.html and - - http://www.w3.org/TR/REC-xml for information - about this namespace. -

-

- Note that local names in this namespace are intended to be - defined only by the World Wide Web Consortium or its subgroups. - The names currently defined in this namespace are listed below. - They should not be used with conflicting semantics by any Working - Group, specification, or document instance. -

-

- See further below in this document for more information about how to refer to this schema document from your own - XSD schema documents and about the - namespace-versioning policy governing this schema document. -

-
-
- - - - - - -
- -

lang (as an attribute name)

-

- denotes an attribute whose value - is a language code for the natural language of the content of - any element; its value is inherited. This name is reserved - by virtue of its definition in the XML specification.

- -
-
-

Notes

-

- Attempting to install the relevant ISO 2- and 3-letter - codes as the enumerated possible values is probably never - going to be a realistic possibility. -

-

- See BCP 47 at - http://www.rfc-editor.org/rfc/bcp/bcp47.txt - and the IANA language subtag registry at - - http://www.iana.org/assignments/language-subtag-registry - for further information. -

-

- The union allows for the 'un-declaration' of xml:lang with - the empty string. -

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

space (as an attribute name)

-

- denotes an attribute whose - value is a keyword indicating what whitespace processing - discipline is intended for the content of the element; its - value is inherited. This name is reserved by virtue of its - definition in the XML specification.

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

base (as an attribute name)

-

- denotes an attribute whose value - provides a URI to be used as the base for interpreting any - relative URIs in the scope of the element on which it - appears; its value is inherited. This name is reserved - by virtue of its definition in the XML Base specification.

- -

- See http://www.w3.org/TR/xmlbase/ - for information about this attribute. -

-
- - - - - - - -
- -

id (as an attribute name)

-

- denotes an attribute whose value - should be interpreted as if declared to be of type ID. - This name is reserved by virtue of its definition in the - xml:id specification.

- -

- See http://www.w3.org/TR/xml-id/ - for information about this attribute. -

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

Father (in any context at all)

- -
-

- denotes Jon Bosak, the chair of - the original XML Working Group. This name is reserved by - the following decision of the W3C XML Plenary and - XML Coordination groups: -

-
-

- In appreciation for his vision, leadership and - dedication the W3C XML Plenary on this 10th day of - February, 2000, reserves for Jon Bosak in perpetuity - the XML name "xml:Father". -

-
-
-
- - - - - -
-

About this schema document

- -
-

- This schema defines attributes and an attribute group suitable - for use by schemas wishing to allow xml:base, - xml:lang, xml:space or - xml:id attributes on elements they define. -

-

- To enable this, such a schema must import this schema for - the XML namespace, e.g. as follows: -

- 
-          <schema . . .>
-           . . .
-           <import namespace="http://www.w3.org/XML/1998/namespace"
-                      schemaLocation="http://www.w3.org/2001/xml.xsd"/>
-
-

- or -

- 
-           <import namespace="http://www.w3.org/XML/1998/namespace"
-                      schemaLocation="http://www.w3.org/2009/01/xml.xsd"/>
-
-

- Subsequently, qualified reference to any of the attributes or the - group defined below will have the desired effect, e.g. -

- 
-          <type . . .>
-           . . .
-           <attributeGroup ref="xml:specialAttrs"/>
-
-

- will define a type which will schema-validate an instance element - with any of those attributes. -

-
-
- - - - - -
-

Versioning policy for this schema document

-
-

- In keeping with the XML Schema WG's standard versioning - policy, this schema document will persist at - - http://www.w3.org/2009/01/xml.xsd. -

-

- At the date of issue it can also be found at - - http://www.w3.org/2001/xml.xsd. -

-

- The schema document at that URI may however change in the future, - in order to remain compatible with the latest version of XML - Schema itself, or with the XML namespace itself. In other words, - if the XML Schema or XML namespaces change, the version of this - document at - http://www.w3.org/2001/xml.xsd - - will change accordingly; the version at - - http://www.w3.org/2009/01/xml.xsd - - will not change. -

-

- Previous dated (and unchanging) versions of this schema - document are at: -

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

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

- - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/guide/src/docbkx/xsd/extensions.xsd b/doc/guide/src/docbkx/xsd/extensions.xsd deleted file mode 100644 index a942f0a1c9..0000000000 --- a/doc/guide/src/docbkx/xsd/extensions.xsd +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- There should be at least one atom link - with a describedby relation. -

- - - - - - - - - - - - diff --git a/doc/guide/src/docbkx/xsd/fault.xsd b/doc/guide/src/docbkx/xsd/fault.xsd deleted file mode 100644 index 6725e3a4d9..0000000000 --- a/doc/guide/src/docbkx/xsd/fault.xsd +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - - - - - - - - - - - - - - -

- A human readable message that is appropriate for display - to the end user. -

- - - - - - -

- The optional <details> element may contain useful - information for tracking down errors (e.g a stack - trace). This information may or may not be appropriate - for display to an end user. -

- - - - - - - - -

- The HTTP status code associated with the current fault. -

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

- An optional dateTime denoting when an operation should - be retried. -

- - - - - - - - diff --git a/doc/guide/src/docbkx/xsd/roles.xsd b/doc/guide/src/docbkx/xsd/roles.xsd deleted file mode 100755 index c01c190ab3..0000000000 --- a/doc/guide/src/docbkx/xsd/roles.xsd +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - - - - -

- A list of roles. -

- - - - - - - -

- A role. -

- - - - - - - - -

- A list of roles refs. -

- - - - - - - -

- A role reference. -

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

- A hyperlink refrence to the role URL. -

- - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/doc/guide/src/docbkx/xsd/tenant.xsd b/doc/guide/src/docbkx/xsd/tenant.xsd deleted file mode 100644 index 26ef15fe6b..0000000000 --- a/doc/guide/src/docbkx/xsd/tenant.xsd +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/guide/src/docbkx/xsd/token.xsd b/doc/guide/src/docbkx/xsd/token.xsd deleted file mode 100644 index 5e9aae4632..0000000000 --- a/doc/guide/src/docbkx/xsd/token.xsd +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- A list of services. -

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

- A list of endpoints. -

- - - - - - - -

- The service name. -

- - - - - - - - - -

- The airport code of the region where the endpoint - lives. -

- - - - - - -

- The publically accessible service URL. -

- - - - - - -

- A service URL, accessible only within the - Rackspace Cloud. -

- - - - - - -

- A service URL used for administration. This may expose - additional functionality not found in the public and - internal URL. -

- - - - - - diff --git a/doc/guide/src/docbkx/xsd/user.xsd b/doc/guide/src/docbkx/xsd/user.xsd deleted file mode 100755 index 991a1fb4b3..0000000000 --- a/doc/guide/src/docbkx/xsd/user.xsd +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - - - - - - -

- A list of Users. -

- - - - - - - -

- A Keystone User. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/guide/src/docbkx/xsd/version.xsd b/doc/guide/src/docbkx/xsd/version.xsd deleted file mode 100644 index 6b2403bd35..0000000000 --- a/doc/guide/src/docbkx/xsd/version.xsd +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - The VersionStatus type describes a service's operational status. - - - - - - - - - - - - - - - - - A version choice list outlines a collection of service version choices. - - - - - - - - - - - - - - In version lists, every single version must - contain at least one self link. - - - - - - - - - - - - - - When used as a root element, a version choice - must contain at least one describedby link. - - - - - - - - - - - - - A version choice contains relevant information about an available service - that a user can then use to target a specific version of the service. Note - that both the descriptive media types and the atom link references are - not manditory and are offered as message enrichment elements rather - than message requirements. - - - - - - - - - - - - - - - The ID of a version choice represents the service version's unique - identifier. This ID is guaranteed to be unique only among the - service version choices outlined in the VersionChoiceList. - - - - - - - - - - A version choice's status describes the current operational state of - the given service version. The operational status is captured in a - simple type enumeration called VersionStatus. - - - - - - - - - - A version choice's updated attribute describes - the time when the version was updated. The - time should be updated anytime - anything in the - version has changed: documentation, - extensions, bug fixes. - - - - - - - - - - - - A MediaTypeList outlines a collection of valid media types for a given - service version. - - - - - - - - - - - - - - - - A MediaType describes what content types the service version understands. - - - - - - - - - - - The base of a given media type describes the simple MIME type - that then a more complicated media type can be derived from. These - types are basic and provide no namespace or version specific - data are are only provided as a convenience. Because of this the - base attribute is declared as optional. - - - - - - - - - - The type attribute of a MediaType describes the MIME specific - identifier of the media type in question. This identifier should include - a vendor namespace ( - See RFC 2048) - as well as a version suffix. - - - - - - -