diff --git a/.gitignore b/.gitignore index 3c5c31a552..b4bd577d13 100644 --- a/.gitignore +++ b/.gitignore @@ -24,3 +24,21 @@ trove.iml # Sphinx doc/build/* doc/source/api/* + +# Docs +.DS_Store +apidocs/.DS_Store +apidocs/src/.DS_Store +apidocs/src/samples/.DS_Store +apidocs/includewars.xml +apidocs/src/bookinfo.xml + +# Generated files +target/ +publish-docs/ +/build-*.log.gz + +# Editors +*~ +.*.swp +.bak diff --git a/README.rst b/README.rst index 2f46f2463a..70def2a5bb 100644 --- a/README.rst +++ b/README.rst @@ -49,3 +49,94 @@ To generate a coverage report,run: $ tox -ecover (note: on some boxes, the results may not be accurate unless you run it twice) + + +====== +Docs +====== + +This repository contains the following OpenStack manual: + +* Database Services API Reference + +Prerequisites +------------- +`Apache Maven `_ must be installed to build the +documentation. + +To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:: + + apt-get install maven + +On Fedora 15 and later:: + + yum install maven3 + +Building +-------- +The manuals are in the ``apidocs`` directory. + +To build a specific guide, look for a ``pom.xml`` file within a subdirectory, +then run the ``mvn`` command in that directory. For example:: + + cd apidocs + mvn clean generate-sources + +The generated PDF documentation file is:: + + apidocs/target/docbkx/webhelp/cdb-devguide/cdb-devguide-reviewer.pdf + +The root of the generated HTML documentation is:: + + apidocs/target/docbkx/webhelp/cdb-devguide/content/index.html + +Testing of changes and building of the manual +---------------------------------------------- + +Install the python tox package and run ``tox`` from the top-level +directory to use the same tests that are done as part of our Jenkins +gating jobs. + +If you like to run individual tests, run: + + * ``tox -e checkniceness`` - to run the niceness tests + * ``tox -e checksyntax`` - to run syntax checks + * ``tox -e checkdeletions`` - to check that no deleted files are referenced + * ``tox -e checkbuild`` - to actually build the manual + +tox will use the `openstack-doc-tools package +`_ for execution of +these tests. openstack-doc-tools has a requirement on maven for the +build check. + + +Contributing +============ + +Our community welcomes all people interested in open source cloud +computing, and encourages you to join the `OpenStack Foundation +`_. + +The best way to get involved with the community is to talk with others online +or at a meetup and offer contributions through our processes, the `OpenStack +wiki `_, blogs, or on IRC at ``#openstack`` +on ``irc.freenode.net``. + +We welcome all types of contributions, from blueprint designs to documentation +to testing to deployment scripts. + +If you would like to contribute to the documents, please see the +`Documentation HowTo `_. + +Bugs +==== + +Bugs should be filed on Launchpad, not GitHub: + + https://bugs.launchpad.net/openstack-api-site/ + + +Installing +========== +Refer to http://docs.openstack.org to see where these documents are published +and to learn more about the OpenStack project. diff --git a/apidocs/.gitignore b/apidocs/.gitignore new file mode 100644 index 0000000000..e69de29bb2 diff --git a/apidocs/pom.xml b/apidocs/pom.xml new file mode 100644 index 0000000000..de4662495e --- /dev/null +++ b/apidocs/pom.xml @@ -0,0 +1,169 @@ + + + 4.0.0 + com.rackspace.cloud.dbaas + dbaas-docs + 1.0.0-SNAPSHOT + Database Public API Spec + jar + + + net.sourceforge.saxon + saxon + 9.1.0.8 + + + com.rackspace.cloud.api + wadl-tools + 1.0.9 + + + + + + com.rackspace.cloud.api + clouddocs-maven-plugin + + + 1.15.0 + + + + cdb-devguide + + generate-webhelp + + generate-sources + + reviewer + src + false + 2 + + + 1 + UA-23102455-4 + cdb-devguide.xml + http://docs.rackspace.com/cdb/api/v1.0/cdb-devguide/content + mike.asthalter@rackspace.com + + + + + + 1 + mike.asthalter@rackspace.com + openstack + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + unpack-shared-resources + + unpack-dependencies + + generate-sources + + ${project.build.directory}/generated-resources + com.rackspace.cloud.api + wadl-tools + true + **/xsl/*.xsl + + + + + + + org.apache.maven.plugins + maven-antrun-plugin + 1.5 + + + ant + generate-sources + + + + + + + + + + + + + + + + + + + + + + + + + + + run + + + + + + org.apache.maven.plugins + maven-assembly-plugin + 2.3 + + + includewars.xml + + + + + assembly + + single + + package + + + + + + + + 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/apidocs/replacements.config b/apidocs/replacements.config new file mode 100644 index 0000000000..e595a773e5 --- /dev/null +++ b/apidocs/replacements.config @@ -0,0 +1,6 @@ +XPATH=//text() +accountId->tenantId +accountID->tenantID +account ID->tenant ID +ord.databases.api.rackspacecloud.com->openstack.example.com +.*Repose.*\n-> \ No newline at end of file diff --git a/apidocs/src/cdb-devguide.xml b/apidocs/src/cdb-devguide.xml new file mode 100644 index 0000000000..b58ae7b059 --- /dev/null +++ b/apidocs/src/cdb-devguide.xml @@ -0,0 +1,969 @@ + + + + + + + + GET'> + PUT'> + POST'> + DELETE'> + + + + + + + + + + + + '> + + + + + + '> +]> + + + + OpenStack Cloud Databases Developer Guide + OpenStack Cloud Databases Developer + Guide + + + + + + + + OpenStack LLC + + + + 2010 + 2011 + 2012 + 2013 + OpenStack LLC + + API v1.0 + OpenStack Cloud Databases + 2013-05-02 + + + Copyright details are filled in by the + template. + + + + This document is intended for software developers + interested in developing applications using the + OpenStack Cloud Databases Application Programming + Interface (API). + + + + + 2013-05-02 + + + + This document is for the initial + OpenStack review. + + + + + + + + this is a placeholder for the front cover + + + this is a placeholder for the back cover + + + API Developer Guide + cdb + 20 + + + + Overview + OpenStack Cloud Databases is an OpenStack-based MySQL + relational database service that allows customers to + easily provision database instances of varying virtual + resource sizes without the need to maintain and/or update + MySQL. Interactions with Cloud Databases occur + programmatically via the Cloud Databases API as described + in this developer guide. + + OpenStack recommends that Cloud Databases users back + up their data using mysqldump until backups are supported + in Cloud Databases. + + The following figure shows an overview of Cloud + Databases Infrastructure: + + + + + + + + Reviewer: need to edit graphic + above so it says "The Cloud" rather than "The Rackspace + Cloud". + +
+ Intended Audience + This Guide is intended to assist software developers + who want to develop applications using the Cloud + Databases API. It assumes the reader has a general + understanding of databases and is familiar + with: + + + ReSTful web services + + + HTTP/1.1 conventions + + + JSON and/or XML data serialization + formats + + +
+ +
+ Document Change History + This version of the Developer Guide replaces and + obsoletes all previous versions. The most recent + changes are described in the table below: + +
+
+ Additional Resources + You can download the most current versions of this + and other API-related documents from http://docs.openstack.org/. + We welcome feedback, comments, and bug reports at + https://bugs.launchpad.net/reddwarf. + This API uses standard HTTP 1.1 response codes as + documented at: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html. +
+ +
+ + + Concepts + + To use the Cloud Databases API effectively, you should + understand several key concepts: +
+ Database Instance + A database instance is an isolated MySQL instance in + a single tenant environment on a shared physical host + machine. + Writer: once we support + MSSQL, we need to describe here what is used for MSSQL + in place of database instance. +
+
+ Database + A MySQL database within a database instance. + Writer: once we support + MSSQL, we need to modify the wording here, such as: + The actual database, whether it is in MySQL or + MSSQL. +
+
+ Flavor + A flavor is an available hardware configuration for + a database instance. Each flavor has a unique + combination of memory capacity and priority for CPU + time. +
+
+ Volume + A volume is user-specified storage that contains the + MySQL data directory. Volumes are automatically + provisioned on shared Internet Small Computer System + Interface (iSCSI) storage area networks (SAN) that + provide for increased performance, scalability, + availability and manageability. Applications with high + I/O demands are performance optimized and data is + protected through both local and network RAID-10. + Additionally, network RAID provides synchronous + replication of volumes with automatic failover and + load balancing across available storage + clusters. +
+
+ + General API Information + The Cloud Databases API is implemented using a ReSTful + web service interface. Like other cloud products, the + Database Service shares a common token-based + authentication system that allows seamless access between + products and services. + + All requests to authenticate against and operate the + service are performed using SSL over HTTP (HTTPS) on + TCP port 443. + +
+ Authentication + Each HTTP request against the Cloud Database service + requires the inclusion of specific authentication + credentials. A single deployment may support multiple + authentication schemes (OAuth, Basic Auth, Token). The + authentication scheme used is determined by the + provider of the Cloud Database service. Please contact + your provider to determine the best way to + authenticate against this API. + + Some authentication schemes may require that the + API operate using SSL over HTTP (HTTPS). + +
+
+ Cloud Databases Service Versions + The Cloud Databases version defines the contract and + build information for the API. +
+ Contract Version + The contract version denotes the data model and + behavior that the API supports. The requested + contract version is included in all request URLs. + Different contract versions of the API may be + available at any given time and are not guaranteed + to be compatible with one another. + + Example Request URL (contract version in + <emphasis role="strong" + >bold</emphasis>) + https://ord.databases.api.rackspacecloud.com/v1.0/1234 + + + This document pertains to contract version + 1.0. + + +
+
+ API Version + The API List Versions call is available to show + the current API version as well as information + about all versions of the API. Refer to for details. +
+
+ +
+ Date/Time Format + The Database Service uses an ISO-8601 compliant date + format for the display and consumption of date/time + values. + The system timezone is in UTC. MySQL converts + TIMESTAMP values from the current time zone to UTC for + storage, and back from UTC to the current time zone + for retrieval. This does not occur for other types, + such as DATETIME. + + DB Service Date/Time Format + yyyy-MM-dd'T'HH:mm:ss.SSSZ + See the table below for a description of the + date/time format codes. + May 19th, 2011 at 8:07:08 AM, GMT-5 would have + the following format: + 2011-05-19T08:07:08-05:00 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Explanation of Date/Time Format + Codes
CodeDescription
yyyyFour digit year
MMTwo digit month
ddTwo digit day of month
TSeparator for date/time
HHTwo digit hour of day (00-23)
mmTwo digit minutes of hour
ssTwo digit seconds of the minute
SSSThree digit milliseconds of the + second
ZRFC-822 timezone
+ +
+
+ Pagination + To reduce load on the service, list operations + return a maximum of 20 items at a time. This is + referred to as pagination. Cloud + Databases has separate paging limits for instances, + databases, and users, which are currently all set to + 20. If a request supplies no limit or one that exceeds + the configured default limit, the default is used + instead. + Pagination provides the ability to limit the size of + the returned data as well as retrieve a specified + subset of a large data set. Pagination has two key + concepts: limit and marker. Limit + is the restriction on the maximum number of items for + that type that can be returned. + Marker is the ID of the last + item in the previous list returned. The ID is the UUID + in the case of instances, and the name in the case of + databases and users. For example, a query could + request the next 10 instances after the instance + "1234" as follows: + ?limit=10&marker=1234. Items are + displayed sorted by ID. + Pagination applies only to the calls listed in the + following table: + + + + Verb + URI + Description + + + + + &GET; + /instances/ + Lists the status and + information for all database + instances. + + + &GET; + + /instances/{instanceId}/databases + Lists databases for the + specified instance. + + + &GET; + + /instances/{instanceId}/users + Lists the users in the + specified database instance. + + + + If the content returned by a call is paginated, the + response includes a structured link much like an + instance item's links, with the basic structure + {"href": "<url>", "rel": "next"}. + Any response that is truncated by pagination will have + a next link, which points to the + next item in the collection. If there are no more + items, no next link is + returned. + See the examples of paged List Instances calls that + follow. + Reviewer: Need new examples + that show OpenStack host. + + List Instances Paged Request: XML + + + + + List Instances Paged Request: JSON + + + + Notice that the paged request examples above set the + limit to 2 (?limit=2), so the responses + that follow each show 2 instances and return a + marker set to the UUID of the + last item in the returned list + (?marker=4137d6a4-03b7-4b66-b0ef-8c7c35c470d3). + Also a link is provided to retrieve the next 2 results + (limit=2) in the link element + identified by the attribute rel="next" + (XML) or "rel":"next" (JSON): + + List Instances Paged Response: XML + + HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 1538 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) + + + + List Instances Paged Response: JSON + + HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 1172 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) + + +
+
+ Faults + When an error occurs, the Database Service returns a + fault object containing an HTTP error response code + that denotes the type of error. In the body of the + response, the system will return additional + information about the fault. + The following table lists possible fault types with + their associated error codes and descriptions. + + + + Fault Type + Associated Error Code + Description + + + + + badRequest + 400 + There was one or more errors + in the user request. + + + unauthorized + 401 + The supplied token is not + authorized to access the resources, either + it's expired or invalid. + + + forbidden + 403 + Access to the requested + resource was denied. + + + itemNotFound + 404 + The back-end services did not + find anything matching the + Request-URI. + + + badMethod + 405 + The request method is not + allowed for this resource. + + + overLimit + 413 + Either the number of entities + in the request is larger than allowed + limits, or the user has exceeded allowable + request rate limits. See the + details element for more + specifics. Contact support if you think + you need higher request rate limits. + + + badMediaType + 415 + The requested content type is + not supported by this service. + + + unprocessableEntity + 422 + The requested resource could + not be processed on at the moment. + + + instanceFault + 500 + This is a generic server error + and the message contains the reason for + the error. This error could wrap several + error messages and is a catch all. + + + notImplemented + 501 + The requested method or + resource is not implemented. + + + serviceUnavailable + 503 + The Database Service is not + available. + + + + The following two instanceFault + examples show errors when the server has erred or + cannot perform the requested operation: + + + Example instanceFault Response: XML + + HTTP/1.1 500 Internal Server Error +Content-Type: application/xml +Content-Length: 121 +Date: Mon, 28 Nov 2011 18:19:37 GMT + + + + Example Fault Response: JSON + + HTTP/1.1 500 Internal Server Error +Content-Length: 120 +Content-Type: application/json; charset=UTF-8 +Date: Tue, 29 Nov 2011 00:33:48 GMT + + + The error code (code) is returned in + the body of the response for convenience. The + message element returns a + human-readable message that is appropriate for display + to the end user. The details element is + optional and may contain information that is useful + for tracking down an error, such as a stack trace. The + details element may or may not be + appropriate for display to an end user, depending on + the role and experience of the end user. + The fault's root element (for example, + instanceFault) may change depending + on the type of error. + The following two + badRequest examples show errors when + the volume size is invalid: + + Example badRequest Fault on Volume Size Errors: + XML + + HTTP/1.1 400 None +Content-Type: application/xml +Content-Length: 121 +Date: Mon, 28 Nov 2011 18:19:37 GMT + + + + Example badRequest Fault on Volume Size Errors: + JSON + + HTTP/1.1 400 None +Content-Length: 120 +Content-Type: application/json; charset=UTF-8 +Date: Tue, 29 Nov 2011 00:33:48 GMT + + + The next two examples show itemNotFound + errors: + + Example itemNotFound Fault: XML + + HTTP/1.1 404 Not Found +Content-Length: 147 +Content-Type: application/xml; charset=UTF-8 +Date: Mon, 28 Nov 2011 19:50:15 GMT + + + + Example itemNotFound Fault: JSON + + HTTP/1.1 404 Not Found +Content-Length: 78 +Content-Type: application/json; charset=UTF-8 +Date: Tue, 29 Nov 2011 00:35:24 GMT + + +
+ Synchronous Versus Asynchronous + Faults<?sbr?> + Synchronous faults occur at + request time. When a synchronous fault occurs, the + fault contains an HTTP error response code, a + human readable message, and optional details about + the error. The following Database API calls are + synchronous and may produce synchronous + faults: + + List Users + + + List Instances + + + List Instance Details by ID + + + List Databases + + + Enable Root User + + + List Root-Enabled Status + + + List Flavors + + + List Versions + + + List Version Details + + + Asynchronous faults occur + in the background while an instance, database, or + user is being built or an instance is executing an + action. When an asynchronous fault occurs, the + system places the instance, database, or user in + an ERROR state and embeds the fault in the + offending instance, database, or user. When an + asynchronous fault occurs, the fault contains an + HTTP error response code, a human readable + message, and optional details about the error. The + following Database API calls are asynchronous and + may produce asynchronous faults: + + Create Instance + + + Delete Instance + + + Create Database + + + Delete Database + + + Create User + + + Delete User + + + Resize Volume + + + Resize Instance + + + Restart Instance + + + + Note that an asynchronous operation, if + it fails, may not give the user an error, + and the operation can error out without a + failure notification. + +
+
+
+ Database Instance Status + When making an API call to + create, list, or delete database instance(s), the + following database instance status values are + possible: + + + BUILD – The database instance is being + provisioned. + + + REBOOT – The database instance is + rebooting. + + + ACTIVE – The database instance is + online and available to take requests. + + + BLOCKED – The database instance is + unresponsive at the moment. + + + RESIZE – The database instance is + being resized at the moment. + + + SHUTDOWN – The database instance is + terminating services. Also, SHUTDOWN is + returned if for any reason the MySQL instance + is shut down but not the actual server. + + If MySQL has crashed (causing the + SHUTDOWN status), please call support for + assistance. + + + + ERROR – The last operation for the + database instance failed due to an + error. + + +
+
+ + + API Operations + + Do not use trailing slashes (/) at the end of calls + to API operations, since this may cause the call to + fail. For example, do not use &GET; /instances/detail/ + (with the trailing slash at the end). Rather, use + &GET; /instances/detail instead. + + +
+ API Versions + This section describes the versions that are + supported for the Cloud Databases API. + + + + + + + + + +
+ +
+ Database Instances + This section describes the operations that are + supported for database instances. + + + + + + + + + + + + + + + +
+ +
+ Database Instance Actions + This section describes the actions that are + supported for database instances. + + + + + + + +
+ +
+ Databases + This section describes the operations that are + supported for databases. + + + + + + + + + +
+ +
+ Users + This section describes the operations that are + supported for managing database users. + In this section, "user has access to a database" + means that the user has full create, read, update, and + delete access to the given database. In other words, + on a cloud database instance, a user named USER and a + database named DATABASE exist, and within MySQL, a + GRANT ALL ON DATABASE.* TO USER has been issued on the + instance. + + There is a bug in a python library that + development is using that may cause incorrect user + deletions to occur if a period (.) is used in the + user name. In this case, the user name is + truncated to remove the portion of the name from + the period to the end, leaving only the portion + from the beginning up to the period. For example, + for a user named "my.userA", the bug would + truncate the user name to "my", and if the user + "my" exists, that user will be incorrectly + deleted. To avoid the problem, do not use periods + in user names. + + + + + + + + + + + + + + + + + + + +
+ +
+ Flavors + This section describes the operations that are + supported for flavors. + + + + + + + + + +
+
+ + Glossary + + database + + A MySQL database within a database + instance. + + + + database instance + + A database instance is an isolated MySQL + instance in a single tenant environment on a + shared physical host machine. Also referred to as + instance. + + + + flavor + + A flavor is an available hardware configuration + for a database instance. Each flavor has a unique + combination of memory capacity and priority for + CPU time. + + + + volume + + A volume is user-specified storage that contains + the MySQL data directory. Volumes are + automatically provisioned on shared Internet Small + Computer System Interface (iSCSI) storage area + networks (SAN) that provide for increased + performance, scalability, availability and + manageability. Applications with high I/O demands + are performance optimized and data is protected + through both local and network RAID-10. + Additionally, network RAID provides synchronous + replication of volumes with automatic failover and + load balancing across available storage + clusters. + + + +
diff --git a/apidocs/src/images/Choose_CS_Image.png b/apidocs/src/images/Choose_CS_Image.png new file mode 100644 index 0000000000..b60a9df8a9 Binary files /dev/null and b/apidocs/src/images/Choose_CS_Image.png differ diff --git a/apidocs/src/images/Choose_CS_Image_CCP.png b/apidocs/src/images/Choose_CS_Image_CCP.png new file mode 100644 index 0000000000..2e6f23ebea Binary files /dev/null and b/apidocs/src/images/Choose_CS_Image_CCP.png differ diff --git a/apidocs/src/images/Choose_Image_CCP.png b/apidocs/src/images/Choose_Image_CCP.png new file mode 100644 index 0000000000..14a555722b Binary files /dev/null and b/apidocs/src/images/Choose_Image_CCP.png differ diff --git a/apidocs/src/images/Choose_Image_CCP.tiff b/apidocs/src/images/Choose_Image_CCP.tiff new file mode 100644 index 0000000000..79d5a45faf Binary files /dev/null and b/apidocs/src/images/Choose_Image_CCP.tiff differ diff --git a/apidocs/src/images/Cloud_DB_Infographic-1.png b/apidocs/src/images/Cloud_DB_Infographic-1.png new file mode 100644 index 0000000000..7a00ae001b Binary files /dev/null and b/apidocs/src/images/Cloud_DB_Infographic-1.png differ diff --git a/apidocs/src/images/Cloud_DB_Infographic-1.svg b/apidocs/src/images/Cloud_DB_Infographic-1.svg new file mode 100644 index 0000000000..4a3f125abb --- /dev/null +++ b/apidocs/src/images/Cloud_DB_Infographic-1.svg @@ -0,0 +1,4533 @@ + + + + +]> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/apidocs/src/images/Create_CS.png b/apidocs/src/images/Create_CS.png new file mode 100644 index 0000000000..32c291b347 Binary files /dev/null and b/apidocs/src/images/Create_CS.png differ diff --git a/apidocs/src/images/phpMyAdmin.png b/apidocs/src/images/phpMyAdmin.png new file mode 100644 index 0000000000..80f909f99f Binary files /dev/null and b/apidocs/src/images/phpMyAdmin.png differ diff --git a/apidocs/src/samples/db-change-users-password-request-json.txt b/apidocs/src/samples/db-change-users-password-request-json.txt new file mode 100644 index 0000000000..c42ecdff94 --- /dev/null +++ b/apidocs/src/samples/db-change-users-password-request-json.txt @@ -0,0 +1,6 @@ +PUT /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-change-users-password-request-xml.txt b/apidocs/src/samples/db-change-users-password-request-xml.txt new file mode 100644 index 0000000000..32eb456d95 --- /dev/null +++ b/apidocs/src/samples/db-change-users-password-request-xml.txt @@ -0,0 +1,6 @@ +PUT /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-change-users-password-request.json b/apidocs/src/samples/db-change-users-password-request.json new file mode 100644 index 0000000000..1b77d3752d --- /dev/null +++ b/apidocs/src/samples/db-change-users-password-request.json @@ -0,0 +1,12 @@ +{ + "users": [ + { + "name": "dbuser1", + "password": "newpassword" + }, + { + "name": "dbuser2", + "password": "anotherpassword" + } + ] +} \ No newline at end of file diff --git a/apidocs/src/samples/db-change-users-password-request.xml b/apidocs/src/samples/db-change-users-password-request.xml new file mode 100644 index 0000000000..ecc1882dd7 --- /dev/null +++ b/apidocs/src/samples/db-change-users-password-request.xml @@ -0,0 +1,4 @@ + + + + diff --git a/apidocs/src/samples/db-change-users-password-response-json.txt b/apidocs/src/samples/db-change-users-password-response-json.txt new file mode 100644 index 0000000000..c4d2e8c66f --- /dev/null +++ b/apidocs/src/samples/db-change-users-password-response-json.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Content-Length: 152 +Date: Wed, 21 Mar 2012 17:46:46 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-change-users-password-response-xml.txt b/apidocs/src/samples/db-change-users-password-response-xml.txt new file mode 100644 index 0000000000..bef81a1eb0 --- /dev/null +++ b/apidocs/src/samples/db-change-users-password-response-xml.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/xml +Content-Length: 501 +Date: Wed, 27 Jun 2012 21:56:06 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-check-root-user-request-json.txt b/apidocs/src/samples/db-check-root-user-request-json.txt new file mode 100644 index 0000000000..1fab86b93d --- /dev/null +++ b/apidocs/src/samples/db-check-root-user-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/root HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-check-root-user-request-xml.txt b/apidocs/src/samples/db-check-root-user-request-xml.txt new file mode 100644 index 0000000000..136931208b --- /dev/null +++ b/apidocs/src/samples/db-check-root-user-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/root HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-check-root-user-response-json.txt b/apidocs/src/samples/db-check-root-user-response-json.txt new file mode 100644 index 0000000000..d0fd061c9b --- /dev/null +++ b/apidocs/src/samples/db-check-root-user-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 21 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-check-root-user-response-xml.txt b/apidocs/src/samples/db-check-root-user-response-xml.txt new file mode 100644 index 0000000000..ceb83cdd4f --- /dev/null +++ b/apidocs/src/samples/db-check-root-user-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 90 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-check-root-user-response.json b/apidocs/src/samples/db-check-root-user-response.json new file mode 100644 index 0000000000..f3990b45ab --- /dev/null +++ b/apidocs/src/samples/db-check-root-user-response.json @@ -0,0 +1,3 @@ +{ + "rootEnabled": true +} diff --git a/apidocs/src/samples/db-check-root-user-response.xml b/apidocs/src/samples/db-check-root-user-response.xml new file mode 100644 index 0000000000..f67b0f8c09 --- /dev/null +++ b/apidocs/src/samples/db-check-root-user-response.xml @@ -0,0 +1,3 @@ + +True diff --git a/apidocs/src/samples/db-create-databases-request-json.txt b/apidocs/src/samples/db-create-databases-request-json.txt new file mode 100644 index 0000000000..61deb76431 --- /dev/null +++ b/apidocs/src/samples/db-create-databases-request-json.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-create-databases-request-xml.txt b/apidocs/src/samples/db-create-databases-request-xml.txt new file mode 100644 index 0000000000..bdf326fd50 --- /dev/null +++ b/apidocs/src/samples/db-create-databases-request-xml.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/databases HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-create-databases-request.json b/apidocs/src/samples/db-create-databases-request.json new file mode 100644 index 0000000000..92ea30ceb0 --- /dev/null +++ b/apidocs/src/samples/db-create-databases-request.json @@ -0,0 +1,15 @@ +{ + "databases": [ + { + "character_set": "utf8", + "collate": "utf8_general_ci", + "name": "testingdb" + }, + { + "name": "anotherdb" + }, + { + "name": "oneMoreDB" + } + ] +} diff --git a/apidocs/src/samples/db-create-databases-request.xml b/apidocs/src/samples/db-create-databases-request.xml new file mode 100644 index 0000000000..5a87d11d96 --- /dev/null +++ b/apidocs/src/samples/db-create-databases-request.xml @@ -0,0 +1,7 @@ + + + + + + diff --git a/apidocs/src/samples/db-create-databases-response-json.txt b/apidocs/src/samples/db-create-databases-response-json.txt new file mode 100644 index 0000000000..6c2d463a53 --- /dev/null +++ b/apidocs/src/samples/db-create-databases-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-create-databases-response-xml.txt b/apidocs/src/samples/db-create-databases-response-xml.txt new file mode 100644 index 0000000000..37fd35c3c6 --- /dev/null +++ b/apidocs/src/samples/db-create-databases-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-create-instance-request-json.txt b/apidocs/src/samples/db-create-instance-request-json.txt new file mode 100644 index 0000000000..a8fcdfb7e0 --- /dev/null +++ b/apidocs/src/samples/db-create-instance-request-json.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-create-instance-request-xml.txt b/apidocs/src/samples/db-create-instance-request-xml.txt new file mode 100644 index 0000000000..554c6a52dc --- /dev/null +++ b/apidocs/src/samples/db-create-instance-request-xml.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-create-instance-request.json b/apidocs/src/samples/db-create-instance-request.json new file mode 100644 index 0000000000..3f14a43968 --- /dev/null +++ b/apidocs/src/samples/db-create-instance-request.json @@ -0,0 +1,30 @@ +{ + "instance":{ + "databases":[ + { + "character_set":"utf8", + "collate":"utf8_general_ci", + "name":"sampledb" + }, + { + "name":"nextround" + } + ], + "flavorRef":1, + "name":"json_rack_instance", + "users":[ + { + "databases":[ + { + "name":"sampledb" + } + ], + "name":"demouser", + "password":"demopassword" + } + ], + "volume":{ + "size":2 + } + } +} diff --git a/apidocs/src/samples/db-create-instance-request.xml b/apidocs/src/samples/db-create-instance-request.xml new file mode 100644 index 0000000000..68ab687ca6 --- /dev/null +++ b/apidocs/src/samples/db-create-instance-request.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + diff --git a/apidocs/src/samples/db-create-instance-response-json.txt b/apidocs/src/samples/db-create-instance-response-json.txt new file mode 100644 index 0000000000..16d5c4cdf2 --- /dev/null +++ b/apidocs/src/samples/db-create-instance-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 591 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-create-instance-response-xml.txt b/apidocs/src/samples/db-create-instance-response-xml.txt new file mode 100644 index 0000000000..886fb7846d --- /dev/null +++ b/apidocs/src/samples/db-create-instance-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 724 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-create-instance-response.json b/apidocs/src/samples/db-create-instance-response.json new file mode 100644 index 0000000000..9e007f5943 --- /dev/null +++ b/apidocs/src/samples/db-create-instance-response.json @@ -0,0 +1,35 @@ +{ + "instance":{ + "created":"2013-03-18T19:09:17", + "flavor":{ + "id":"1", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/flavors/1", + "rel":"bookmark" + } + ] + }, + "id":"44b277eb-39be-4921-be31-3d61b43651d7", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/instances/44b277eb-39be-4921-be31-3d61b43651d7", + "rel":"bookmark" + } + ], + "name":"json_rack_instance", + "status":"BUILD", + "updated":"2013-03-18T19:09:17", + "volume":{ + "size":2 + } + } +} diff --git a/apidocs/src/samples/db-create-instance-response.xml b/apidocs/src/samples/db-create-instance-response.xml new file mode 100644 index 0000000000..37194fcaab --- /dev/null +++ b/apidocs/src/samples/db-create-instance-response.xml @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + diff --git a/apidocs/src/samples/db-create-users-request-json.txt b/apidocs/src/samples/db-create-users-request-json.txt new file mode 100644 index 0000000000..25b79c1226 --- /dev/null +++ b/apidocs/src/samples/db-create-users-request-json.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-create-users-request-xml.txt b/apidocs/src/samples/db-create-users-request-xml.txt new file mode 100644 index 0000000000..4e0d96d027 --- /dev/null +++ b/apidocs/src/samples/db-create-users-request-xml.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/users HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-create-users-request.json b/apidocs/src/samples/db-create-users-request.json new file mode 100644 index 0000000000..c9661acd36 --- /dev/null +++ b/apidocs/src/samples/db-create-users-request.json @@ -0,0 +1,26 @@ +{ + "users":[ + { + "database":"databaseA", + "name":"dbuser1", + "password":"password" + }, + { + "databases":[ + { + "name":"databaseB" + }, + { + "name":"databaseC" + } + ], + "name":"dbuser2", + "password":"password" + }, + { + "database":"databaseD", + "name":"dbuser3", + "password":"password" + } + ] +} diff --git a/apidocs/src/samples/db-create-users-request.xml b/apidocs/src/samples/db-create-users-request.xml new file mode 100644 index 0000000000..f35cb6c819 --- /dev/null +++ b/apidocs/src/samples/db-create-users-request.xml @@ -0,0 +1,11 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/apidocs/src/samples/db-create-users-response-json.txt b/apidocs/src/samples/db-create-users-response-json.txt new file mode 100644 index 0000000000..6c2d463a53 --- /dev/null +++ b/apidocs/src/samples/db-create-users-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-create-users-response-xml.txt b/apidocs/src/samples/db-create-users-response-xml.txt new file mode 100644 index 0000000000..37fd35c3c6 --- /dev/null +++ b/apidocs/src/samples/db-create-users-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-databases-request-json.txt b/apidocs/src/samples/db-delete-databases-request-json.txt new file mode 100644 index 0000000000..d5dfa1edea --- /dev/null +++ b/apidocs/src/samples/db-delete-databases-request-json.txt @@ -0,0 +1,6 @@ +DELETE /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases/testingdb HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-databases-request-xml.txt b/apidocs/src/samples/db-delete-databases-request-xml.txt new file mode 100644 index 0000000000..2a93afd8e6 --- /dev/null +++ b/apidocs/src/samples/db-delete-databases-request-xml.txt @@ -0,0 +1,6 @@ +DELETE /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/databases/oneMoreDB HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-databases-response-json.txt b/apidocs/src/samples/db-delete-databases-response-json.txt new file mode 100644 index 0000000000..6c2d463a53 --- /dev/null +++ b/apidocs/src/samples/db-delete-databases-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-databases-response-xml.txt b/apidocs/src/samples/db-delete-databases-response-xml.txt new file mode 100644 index 0000000000..37fd35c3c6 --- /dev/null +++ b/apidocs/src/samples/db-delete-databases-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-instance-request-json.txt b/apidocs/src/samples/db-delete-instance-request-json.txt new file mode 100644 index 0000000000..d192a425d2 --- /dev/null +++ b/apidocs/src/samples/db-delete-instance-request-json.txt @@ -0,0 +1,6 @@ +DELETE /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-instance-request-xml.txt b/apidocs/src/samples/db-delete-instance-request-xml.txt new file mode 100644 index 0000000000..dceebb7afc --- /dev/null +++ b/apidocs/src/samples/db-delete-instance-request-xml.txt @@ -0,0 +1,6 @@ +DELETE /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-instance-response-json.txt b/apidocs/src/samples/db-delete-instance-response-json.txt new file mode 100644 index 0000000000..4955ecc01f --- /dev/null +++ b/apidocs/src/samples/db-delete-instance-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:18 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-instance-response-xml.txt b/apidocs/src/samples/db-delete-instance-response-xml.txt new file mode 100644 index 0000000000..86306c2665 --- /dev/null +++ b/apidocs/src/samples/db-delete-instance-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:18 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-users-request-json.txt b/apidocs/src/samples/db-delete-users-request-json.txt new file mode 100644 index 0000000000..17738c325f --- /dev/null +++ b/apidocs/src/samples/db-delete-users-request-json.txt @@ -0,0 +1,6 @@ +DELETE /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users/testuser HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-users-request-xml.txt b/apidocs/src/samples/db-delete-users-request-xml.txt new file mode 100644 index 0000000000..b0ac08c660 --- /dev/null +++ b/apidocs/src/samples/db-delete-users-request-xml.txt @@ -0,0 +1,6 @@ +DELETE /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/users/testuser HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-users-response-json.txt b/apidocs/src/samples/db-delete-users-response-json.txt new file mode 100644 index 0000000000..6c2d463a53 --- /dev/null +++ b/apidocs/src/samples/db-delete-users-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-delete-users-response-xml.txt b/apidocs/src/samples/db-delete-users-response-xml.txt new file mode 100644 index 0000000000..37fd35c3c6 --- /dev/null +++ b/apidocs/src/samples/db-delete-users-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-enable-root-user-request-json.txt b/apidocs/src/samples/db-enable-root-user-request-json.txt new file mode 100644 index 0000000000..463e383ba0 --- /dev/null +++ b/apidocs/src/samples/db-enable-root-user-request-json.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/root HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-enable-root-user-request-xml.txt b/apidocs/src/samples/db-enable-root-user-request-xml.txt new file mode 100644 index 0000000000..5f65168b03 --- /dev/null +++ b/apidocs/src/samples/db-enable-root-user-request-xml.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/root HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-enable-root-user-response-json.txt b/apidocs/src/samples/db-enable-root-user-response-json.txt new file mode 100644 index 0000000000..6dc4bb7b5d --- /dev/null +++ b/apidocs/src/samples/db-enable-root-user-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 47 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-enable-root-user-response-xml.txt b/apidocs/src/samples/db-enable-root-user-response-xml.txt new file mode 100644 index 0000000000..2db96b8f73 --- /dev/null +++ b/apidocs/src/samples/db-enable-root-user-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 89 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-enable-root-user-response.json b/apidocs/src/samples/db-enable-root-user-response.json new file mode 100644 index 0000000000..4be60a595e --- /dev/null +++ b/apidocs/src/samples/db-enable-root-user-response.json @@ -0,0 +1,6 @@ +{ + "user": { + "name": "root", + "password": "12345" + } +} diff --git a/apidocs/src/samples/db-enable-root-user-response.xml b/apidocs/src/samples/db-enable-root-user-response.xml new file mode 100644 index 0000000000..4c6d9f98a8 --- /dev/null +++ b/apidocs/src/samples/db-enable-root-user-response.xml @@ -0,0 +1,3 @@ + + diff --git a/apidocs/src/samples/db-faults-badRequest.json b/apidocs/src/samples/db-faults-badRequest.json new file mode 100644 index 0000000000..2b04f07d3c --- /dev/null +++ b/apidocs/src/samples/db-faults-badRequest.json @@ -0,0 +1,6 @@ +{ + "badRequest": { + "code": 400, + "message": "Volume 'size' needs to be a positive integer value, -1.0 cannot be accepted." + } +} diff --git a/apidocs/src/samples/db-faults-badRequest.xml b/apidocs/src/samples/db-faults-badRequest.xml new file mode 100644 index 0000000000..74344158de --- /dev/null +++ b/apidocs/src/samples/db-faults-badRequest.xml @@ -0,0 +1,6 @@ + + + Volume 'size' needs to be a positive integer value, -1.0 + cannot be accepted. + diff --git a/apidocs/src/samples/db-faults-instanceFault.json b/apidocs/src/samples/db-faults-instanceFault.json new file mode 100644 index 0000000000..e9b42d5ce0 --- /dev/null +++ b/apidocs/src/samples/db-faults-instanceFault.json @@ -0,0 +1,6 @@ +{ + "instanceFault": { + "code": 500, + "message": "The server has either erred or is incapable of performing the requested operation." + } +} diff --git a/apidocs/src/samples/db-faults-instanceFault.xml b/apidocs/src/samples/db-faults-instanceFault.xml new file mode 100644 index 0000000000..f3aa040a54 --- /dev/null +++ b/apidocs/src/samples/db-faults-instanceFault.xml @@ -0,0 +1,6 @@ + + + The server has either erred or is incapable of + performing the requested operation. + diff --git a/apidocs/src/samples/db-faults-itemNotFound.json b/apidocs/src/samples/db-faults-itemNotFound.json new file mode 100644 index 0000000000..6c7318392f --- /dev/null +++ b/apidocs/src/samples/db-faults-itemNotFound.json @@ -0,0 +1,6 @@ +{ + "itemNotFound": { + "code": 404, + "message": "The resource could not be found." + } +} diff --git a/apidocs/src/samples/db-faults-itemNotFound.xml b/apidocs/src/samples/db-faults-itemNotFound.xml new file mode 100644 index 0000000000..0b5699c935 --- /dev/null +++ b/apidocs/src/samples/db-faults-itemNotFound.xml @@ -0,0 +1,5 @@ + + + The resource could not be found. + diff --git a/apidocs/src/samples/db-flavors-by-id-request-json.txt b/apidocs/src/samples/db-flavors-by-id-request-json.txt new file mode 100644 index 0000000000..b8c5c33f8b --- /dev/null +++ b/apidocs/src/samples/db-flavors-by-id-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/flavors/1 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-flavors-by-id-request-xml.txt b/apidocs/src/samples/db-flavors-by-id-request-xml.txt new file mode 100644 index 0000000000..97ccb7c2b1 --- /dev/null +++ b/apidocs/src/samples/db-flavors-by-id-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/flavors/1 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-flavors-by-id-response-json.txt b/apidocs/src/samples/db-flavors-by-id-response-json.txt new file mode 100644 index 0000000000..d7fa6a708c --- /dev/null +++ b/apidocs/src/samples/db-flavors-by-id-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 206 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-flavors-by-id-response-xml.txt b/apidocs/src/samples/db-flavors-by-id-response-xml.txt new file mode 100644 index 0000000000..7fb6d519a0 --- /dev/null +++ b/apidocs/src/samples/db-flavors-by-id-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 283 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-flavors-by-id-response.json b/apidocs/src/samples/db-flavors-by-id-response.json new file mode 100644 index 0000000000..3a34ee3bd9 --- /dev/null +++ b/apidocs/src/samples/db-flavors-by-id-response.json @@ -0,0 +1,17 @@ +{ + "flavor": { + "id": 1, + "links": [ + { + "href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1", + "rel": "self" + }, + { + "href": "https://ord.databases.api.rackspacecloud.com/flavors/1", + "rel": "bookmark" + } + ], + "name": "512MB Instance", + "ram": 512 + } +} diff --git a/apidocs/src/samples/db-flavors-by-id-response.xml b/apidocs/src/samples/db-flavors-by-id-response.xml new file mode 100644 index 0000000000..de558f5abb --- /dev/null +++ b/apidocs/src/samples/db-flavors-by-id-response.xml @@ -0,0 +1,12 @@ + + + + + + + diff --git a/apidocs/src/samples/db-flavors-request-json.txt b/apidocs/src/samples/db-flavors-request-json.txt new file mode 100644 index 0000000000..c1b7272476 --- /dev/null +++ b/apidocs/src/samples/db-flavors-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/flavors HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-flavors-request-xml.txt b/apidocs/src/samples/db-flavors-request-xml.txt new file mode 100644 index 0000000000..a42b20ad3d --- /dev/null +++ b/apidocs/src/samples/db-flavors-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/flavors HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-flavors-response-json.txt b/apidocs/src/samples/db-flavors-response-json.txt new file mode 100644 index 0000000000..2244dbd4e6 --- /dev/null +++ b/apidocs/src/samples/db-flavors-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 1186 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-flavors-response-xml.txt b/apidocs/src/samples/db-flavors-response-xml.txt new file mode 100644 index 0000000000..ab84ce30fd --- /dev/null +++ b/apidocs/src/samples/db-flavors-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 1600 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-flavors-response.json b/apidocs/src/samples/db-flavors-response.json new file mode 100644 index 0000000000..f7bc58f9e8 --- /dev/null +++ b/apidocs/src/samples/db-flavors-response.json @@ -0,0 +1,94 @@ +{ + "flavors": [ + { + "id": 1, + "links": [ + { + "href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1", + "rel": "self" + }, + { + "href": "https://ord.databases.api.rackspacecloud.com/flavors/1", + "rel": "bookmark" + } + ], + "name": "512MB Instance", + "ram": 512 + }, + { + "id": 2, + "links": [ + { + "href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2", + "rel": "self" + }, + { + "href": "https://ord.databases.api.rackspacecloud.com/flavors/2", + "rel": "bookmark" + } + ], + "name": "1GB Instance", + "ram": 1024 + }, + { + "id": 3, + "links": [ + { + "href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/3", + "rel": "self" + }, + { + "href": "https://ord.databases.api.rackspacecloud.com/flavors/3", + "rel": "bookmark" + } + ], + "name": "2GB Instance", + "ram": 2048 + }, + { + "id": 4, + "links": [ + { + "href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/4", + "rel": "self" + }, + { + "href": "https://ord.databases.api.rackspacecloud.com/flavors/4", + "rel": "bookmark" + } + ], + "name": "4GB Instance", + "ram": 4096 + }, + { + "id": 5, + "links": [ + { + "href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/5", + "rel": "self" + }, + { + "href": "https://ord.databases.api.rackspacecloud.com/flavors/5", + "rel": "bookmark" + } + ], + "name": "8GB Instance", + "ram": 8192 + }, + { + "id": 6, + "links": [ + { + "href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/6", + "rel": "self" + }, + { + "href": "https://ord.databases.api.rackspacecloud.com/flavors/6", + "rel": "bookmark" + } + ], + "name": "16GB Instance", + "ram": 16384 + } + ] +} diff --git a/apidocs/src/samples/db-flavors-response.xml b/apidocs/src/samples/db-flavors-response.xml new file mode 100644 index 0000000000..75a205468a --- /dev/null +++ b/apidocs/src/samples/db-flavors-response.xml @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/apidocs/src/samples/db-grant-user-access-request-json.txt b/apidocs/src/samples/db-grant-user-access-request-json.txt new file mode 100644 index 0000000000..32c7ac06bf --- /dev/null +++ b/apidocs/src/samples/db-grant-user-access-request-json.txt @@ -0,0 +1,6 @@ +PUT /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/exampleuser/databases HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-grant-user-access-request-xml.txt b/apidocs/src/samples/db-grant-user-access-request-xml.txt new file mode 100644 index 0000000000..cf2b19f375 --- /dev/null +++ b/apidocs/src/samples/db-grant-user-access-request-xml.txt @@ -0,0 +1,6 @@ +PUT /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/testuser/databases HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-grant-user-access-request.json b/apidocs/src/samples/db-grant-user-access-request.json new file mode 100644 index 0000000000..4fca825a47 --- /dev/null +++ b/apidocs/src/samples/db-grant-user-access-request.json @@ -0,0 +1,10 @@ +{ + "databases": [ + { + "name": "databaseC" + }, + { + "name": "databaseD" + } + ] +} \ No newline at end of file diff --git a/apidocs/src/samples/db-grant-user-access-request.xml b/apidocs/src/samples/db-grant-user-access-request.xml new file mode 100644 index 0000000000..8def258d38 --- /dev/null +++ b/apidocs/src/samples/db-grant-user-access-request.xml @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/apidocs/src/samples/db-grant-user-access-response-json.txt b/apidocs/src/samples/db-grant-user-access-response-json.txt new file mode 100644 index 0000000000..af725ba3ae --- /dev/null +++ b/apidocs/src/samples/db-grant-user-access-response-json.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:11:19 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-grant-user-access-response-xml.txt b/apidocs/src/samples/db-grant-user-access-response-xml.txt new file mode 100644 index 0000000000..d6be01e7d0 --- /dev/null +++ b/apidocs/src/samples/db-grant-user-access-response-xml.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/xml +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:11:19 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-resize-instance-request-json.txt b/apidocs/src/samples/db-instance-resize-instance-request-json.txt new file mode 100644 index 0000000000..c1dd4c535f --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-instance-request-json.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/23a3d4fb-3731-497b-afd4-bf25bde2b5fc/action HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 2eeb3252-0164-40f5-8fb7-85df5faa2698 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-resize-instance-request-xml.txt b/apidocs/src/samples/db-instance-resize-instance-request-xml.txt new file mode 100644 index 0000000000..2f18d02ec8 --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-instance-request-xml.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/5d891bb6-6c61-4b0a-8b85-26f4ee461c9d/action HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 2eeb3252-0164-40f5-8fb7-85df5faa2698 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-resize-instance-request.json b/apidocs/src/samples/db-instance-resize-instance-request.json new file mode 100644 index 0000000000..2345c01db8 --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-instance-request.json @@ -0,0 +1,5 @@ +{ + "resize":{ + "flavorRef":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2" + } +} \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-resize-instance-request.xml b/apidocs/src/samples/db-instance-resize-instance-request.xml new file mode 100644 index 0000000000..a2a2aa5268 --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-instance-request.xml @@ -0,0 +1,4 @@ + + + https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2 + diff --git a/apidocs/src/samples/db-instance-resize-instance-response-json.txt b/apidocs/src/samples/db-instance-resize-instance-response-json.txt new file mode 100644 index 0000000000..3e7557206d --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-instance-response-json.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: text/plain; charset=UTF-8 +Content-Length: 58 +Date: Mon, 06 Feb 2012 21:28:10 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-resize-instance-response-xml.txt b/apidocs/src/samples/db-instance-resize-instance-response-xml.txt new file mode 100644 index 0000000000..21728e4b33 --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-instance-response-xml.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: text/plain; charset=UTF-8 +Content-Length: 58 +Date: Mon, 06 Feb 2012 21:28:11 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-resize-volume-request-json.txt b/apidocs/src/samples/db-instance-resize-volume-request-json.txt new file mode 100644 index 0000000000..ee9c9efda4 --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-volume-request-json.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/action HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-resize-volume-request-xml.txt b/apidocs/src/samples/db-instance-resize-volume-request-xml.txt new file mode 100644 index 0000000000..a8608afc1f --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-volume-request-xml.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/action HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-resize-volume-request.json b/apidocs/src/samples/db-instance-resize-volume-request.json new file mode 100644 index 0000000000..de6c2c06aa --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-volume-request.json @@ -0,0 +1,7 @@ +{ + "resize":{ + "volume":{ + "size":4 + } + } +} \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-resize-volume-request.xml b/apidocs/src/samples/db-instance-resize-volume-request.xml new file mode 100644 index 0000000000..3c622db563 --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-volume-request.xml @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-resize-volume-response-json.txt b/apidocs/src/samples/db-instance-resize-volume-response-json.txt new file mode 100644 index 0000000000..4955ecc01f --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-volume-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:18 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-resize-volume-response-xml.txt b/apidocs/src/samples/db-instance-resize-volume-response-xml.txt new file mode 100644 index 0000000000..86306c2665 --- /dev/null +++ b/apidocs/src/samples/db-instance-resize-volume-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:18 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-restart-request-json.txt b/apidocs/src/samples/db-instance-restart-request-json.txt new file mode 100644 index 0000000000..ee9c9efda4 --- /dev/null +++ b/apidocs/src/samples/db-instance-restart-request-json.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/action HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-restart-request-xml.txt b/apidocs/src/samples/db-instance-restart-request-xml.txt new file mode 100644 index 0000000000..a8608afc1f --- /dev/null +++ b/apidocs/src/samples/db-instance-restart-request-xml.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/action HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-restart-request.json b/apidocs/src/samples/db-instance-restart-request.json new file mode 100644 index 0000000000..b378a6d32e --- /dev/null +++ b/apidocs/src/samples/db-instance-restart-request.json @@ -0,0 +1,5 @@ +{ + "restart":{ + + } +} \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-restart-request.xml b/apidocs/src/samples/db-instance-restart-request.xml new file mode 100644 index 0000000000..e6204a4422 --- /dev/null +++ b/apidocs/src/samples/db-instance-restart-request.xml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-restart-response-json.txt b/apidocs/src/samples/db-instance-restart-response-json.txt new file mode 100644 index 0000000000..4955ecc01f --- /dev/null +++ b/apidocs/src/samples/db-instance-restart-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:18 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-restart-response-xml.txt b/apidocs/src/samples/db-instance-restart-response-xml.txt new file mode 100644 index 0000000000..86306c2665 --- /dev/null +++ b/apidocs/src/samples/db-instance-restart-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 0 +Date: Mon, 18 Mar 2013 19:09:18 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-status-detail-request-json.txt b/apidocs/src/samples/db-instance-status-detail-request-json.txt new file mode 100644 index 0000000000..5345f2afde --- /dev/null +++ b/apidocs/src/samples/db-instance-status-detail-request-json.txt @@ -0,0 +1,8 @@ +GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + + diff --git a/apidocs/src/samples/db-instance-status-detail-request-xml.txt b/apidocs/src/samples/db-instance-status-detail-request-xml.txt new file mode 100644 index 0000000000..691a0fe5fa --- /dev/null +++ b/apidocs/src/samples/db-instance-status-detail-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-status-detail-response-json.txt b/apidocs/src/samples/db-instance-status-detail-response-json.txt new file mode 100644 index 0000000000..6d95ecc3e8 --- /dev/null +++ b/apidocs/src/samples/db-instance-status-detail-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 621 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-status-detail-response-xml.txt b/apidocs/src/samples/db-instance-status-detail-response-xml.txt new file mode 100644 index 0000000000..3624c308d5 --- /dev/null +++ b/apidocs/src/samples/db-instance-status-detail-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 747 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-status-detail-response.json b/apidocs/src/samples/db-instance-status-detail-response.json new file mode 100644 index 0000000000..e22c994e8d --- /dev/null +++ b/apidocs/src/samples/db-instance-status-detail-response.json @@ -0,0 +1,36 @@ +{ + "instance":{ + "created":"2013-03-18T19:09:17", + "flavor":{ + "id":"1", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/flavors/1", + "rel":"bookmark" + } + ] + }, + "id":"44b277eb-39be-4921-be31-3d61b43651d7", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/instances/44b277eb-39be-4921-be31-3d61b43651d7", + "rel":"bookmark" + } + ], + "name":"json_rack_instance", + "status":"ACTIVE", + "updated":"2013-03-18T19:09:17", + "volume":{ + "size":2, + "used":0.16368598397821188 + } + } +} \ No newline at end of file diff --git a/apidocs/src/samples/db-instance-status-detail-response.xml b/apidocs/src/samples/db-instance-status-detail-response.xml new file mode 100644 index 0000000000..9a29f4750c --- /dev/null +++ b/apidocs/src/samples/db-instance-status-detail-response.xml @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + diff --git a/apidocs/src/samples/db-instances-index-pagination-request-json.txt b/apidocs/src/samples/db-instances-index-pagination-request-json.txt new file mode 100644 index 0000000000..53c74d8af9 --- /dev/null +++ b/apidocs/src/samples/db-instances-index-pagination-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances?limit=2 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-instances-index-pagination-request-xml.txt b/apidocs/src/samples/db-instances-index-pagination-request-xml.txt new file mode 100644 index 0000000000..2fefbfa9ce --- /dev/null +++ b/apidocs/src/samples/db-instances-index-pagination-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances?limit=2 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-instances-index-pagination-response.json b/apidocs/src/samples/db-instances-index-pagination-response.json new file mode 100644 index 0000000000..afe02bfd03 --- /dev/null +++ b/apidocs/src/samples/db-instances-index-pagination-response.json @@ -0,0 +1,72 @@ +{ + "instances":[ + { + "flavor":{ + "id":"1", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/flavors/1", + "rel":"bookmark" + } + ] + }, + "id":"098653ba-218b-47ce-936a-e0b749101f81", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/instances/098653ba-218b-47ce-936a-e0b749101f81", + "rel":"bookmark" + } + ], + "name":"xml_rack_instance", + "status":"ACTIVE", + "volume":{ + "size":2 + } + }, + { + "flavor":{ + "id":"1", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/flavors/1", + "rel":"bookmark" + } + ] + }, + "id":"44b277eb-39be-4921-be31-3d61b43651d7", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/instances/44b277eb-39be-4921-be31-3d61b43651d7", + "rel":"bookmark" + } + ], + "name":"json_rack_instance", + "status":"ACTIVE", + "volume":{ + "size":2 + } + } + ], + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances?marker=44b277eb-39be-4921-be31-3d61b43651d7&limit=2", + "rel":"next" + } + ] +} \ No newline at end of file diff --git a/apidocs/src/samples/db-instances-index-pagination-response.xml b/apidocs/src/samples/db-instances-index-pagination-response.xml new file mode 100644 index 0000000000..edf9f371b6 --- /dev/null +++ b/apidocs/src/samples/db-instances-index-pagination-response.xml @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/apidocs/src/samples/db-instances-index-request-json.txt b/apidocs/src/samples/db-instances-index-request-json.txt new file mode 100644 index 0000000000..e9a3b9adfb --- /dev/null +++ b/apidocs/src/samples/db-instances-index-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-instances-index-request-xml.txt b/apidocs/src/samples/db-instances-index-request-xml.txt new file mode 100644 index 0000000000..2398d1c8d2 --- /dev/null +++ b/apidocs/src/samples/db-instances-index-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-instances-index-response-json.txt b/apidocs/src/samples/db-instances-index-response-json.txt new file mode 100644 index 0000000000..5fe59c18a9 --- /dev/null +++ b/apidocs/src/samples/db-instances-index-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 1038 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-instances-index-response-xml.txt b/apidocs/src/samples/db-instances-index-response-xml.txt new file mode 100644 index 0000000000..3045ab9a5d --- /dev/null +++ b/apidocs/src/samples/db-instances-index-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 1380 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-instances-index-response.json b/apidocs/src/samples/db-instances-index-response.json new file mode 100644 index 0000000000..3953743910 --- /dev/null +++ b/apidocs/src/samples/db-instances-index-response.json @@ -0,0 +1,66 @@ +{ + "instances":[ + { + "flavor":{ + "id":"1", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/flavors/1", + "rel":"bookmark" + } + ] + }, + "id":"098653ba-218b-47ce-936a-e0b749101f81", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/instances/098653ba-218b-47ce-936a-e0b749101f81", + "rel":"bookmark" + } + ], + "name":"xml_rack_instance", + "status":"ACTIVE", + "volume":{ + "size":2 + } + }, + { + "flavor":{ + "id":"1", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/flavors/1", + "rel":"bookmark" + } + ] + }, + "id":"44b277eb-39be-4921-be31-3d61b43651d7", + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7", + "rel":"self" + }, + { + "href":"https://ord.databases.api.rackspacecloud.com/instances/44b277eb-39be-4921-be31-3d61b43651d7", + "rel":"bookmark" + } + ], + "name":"json_rack_instance", + "status":"ACTIVE", + "volume":{ + "size":2 + } + } + ] +} \ No newline at end of file diff --git a/apidocs/src/samples/db-instances-index-response.xml b/apidocs/src/samples/db-instances-index-response.xml new file mode 100644 index 0000000000..b8c3962f39 --- /dev/null +++ b/apidocs/src/samples/db-instances-index-response.xml @@ -0,0 +1,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/apidocs/src/samples/db-list-databases-pagination-request-json.txt b/apidocs/src/samples/db-list-databases-pagination-request-json.txt new file mode 100644 index 0000000000..fb41189a00 --- /dev/null +++ b/apidocs/src/samples/db-list-databases-pagination-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases?limit=1 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-list-databases-pagination-request-xml.txt b/apidocs/src/samples/db-list-databases-pagination-request-xml.txt new file mode 100644 index 0000000000..69a6868e21 --- /dev/null +++ b/apidocs/src/samples/db-list-databases-pagination-request-xml.txt @@ -0,0 +1,8 @@ +GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/databases?limit=2 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml + + diff --git a/apidocs/src/samples/db-list-databases-pagination-response-json.txt b/apidocs/src/samples/db-list-databases-pagination-response-json.txt new file mode 100644 index 0000000000..9ff78ab338 --- /dev/null +++ b/apidocs/src/samples/db-list-databases-pagination-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 192 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-list-databases-pagination-response-xml.txt b/apidocs/src/samples/db-list-databases-pagination-response-xml.txt new file mode 100644 index 0000000000..d3e545e2e7 --- /dev/null +++ b/apidocs/src/samples/db-list-databases-pagination-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 321 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-list-databases-pagination-response.json b/apidocs/src/samples/db-list-databases-pagination-response.json new file mode 100644 index 0000000000..7335ab6978 --- /dev/null +++ b/apidocs/src/samples/db-list-databases-pagination-response.json @@ -0,0 +1,13 @@ +{ + "databases":[ + { + "name":"anotherdb" + } + ], + "links":[ + { + "href":"https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases?marker=anotherdb&limit=1", + "rel":"next" + } + ] +} diff --git a/apidocs/src/samples/db-list-databases-pagination-response.xml b/apidocs/src/samples/db-list-databases-pagination-response.xml new file mode 100644 index 0000000000..a0f12ddf5b --- /dev/null +++ b/apidocs/src/samples/db-list-databases-pagination-response.xml @@ -0,0 +1,10 @@ + + + + + + + + diff --git a/apidocs/src/samples/db-list-databases-request-json.txt b/apidocs/src/samples/db-list-databases-request-json.txt new file mode 100644 index 0000000000..0a54f4b605 --- /dev/null +++ b/apidocs/src/samples/db-list-databases-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-list-databases-request-xml.txt b/apidocs/src/samples/db-list-databases-request-xml.txt new file mode 100644 index 0000000000..0d8da99541 --- /dev/null +++ b/apidocs/src/samples/db-list-databases-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/databases HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-list-databases-response-json.txt b/apidocs/src/samples/db-list-databases-response-json.txt new file mode 100644 index 0000000000..177d09db6e --- /dev/null +++ b/apidocs/src/samples/db-list-databases-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 129 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-list-databases-response-xml.txt b/apidocs/src/samples/db-list-databases-response-xml.txt new file mode 100644 index 0000000000..c282d91b22 --- /dev/null +++ b/apidocs/src/samples/db-list-databases-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 241 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-list-databases-response.json b/apidocs/src/samples/db-list-databases-response.json new file mode 100644 index 0000000000..8a10ef0526 --- /dev/null +++ b/apidocs/src/samples/db-list-databases-response.json @@ -0,0 +1,19 @@ +{ + "databases":[ + { + "name":"anotherdb" + }, + { + "name":"nextround" + }, + { + "name":"oneMoreDB" + }, + { + "name":"sampledb" + }, + { + "name":"testingdb" + } + ] +} \ No newline at end of file diff --git a/apidocs/src/samples/db-list-databases-response.xml b/apidocs/src/samples/db-list-databases-response.xml new file mode 100644 index 0000000000..82877bf669 --- /dev/null +++ b/apidocs/src/samples/db-list-databases-response.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/apidocs/src/samples/db-list-user-access-request-json.txt b/apidocs/src/samples/db-list-user-access-request-json.txt new file mode 100644 index 0000000000..1e0f1df6e1 --- /dev/null +++ b/apidocs/src/samples/db-list-user-access-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/exampleuser/databases HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-list-user-access-request-xml.txt b/apidocs/src/samples/db-list-user-access-request-xml.txt new file mode 100644 index 0000000000..87c1f5b5bf --- /dev/null +++ b/apidocs/src/samples/db-list-user-access-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/testuser/databases HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-list-user-access-response-json.txt b/apidocs/src/samples/db-list-user-access-response-json.txt new file mode 100644 index 0000000000..54cba76d42 --- /dev/null +++ b/apidocs/src/samples/db-list-user-access-response-json.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:11:19 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-list-user-access-response-xml.txt b/apidocs/src/samples/db-list-user-access-response-xml.txt new file mode 100644 index 0000000000..7032e188d8 --- /dev/null +++ b/apidocs/src/samples/db-list-user-access-response-xml.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:11:19 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-list-user-access-response.json b/apidocs/src/samples/db-list-user-access-response.json new file mode 100644 index 0000000000..4ecc9b43b7 --- /dev/null +++ b/apidocs/src/samples/db-list-user-access-response.json @@ -0,0 +1,10 @@ +{ + "databases": [ + { + "name": "databaseA" + }, + { + "name": "databaseB" + } + ] +} \ No newline at end of file diff --git a/apidocs/src/samples/db-list-user-access-response.xml b/apidocs/src/samples/db-list-user-access-response.xml new file mode 100644 index 0000000000..c4d57491c5 --- /dev/null +++ b/apidocs/src/samples/db-list-user-access-response.xml @@ -0,0 +1,4 @@ + + + + diff --git a/apidocs/src/samples/db-list-user-dbs-request-json.txt b/apidocs/src/samples/db-list-user-dbs-request-json.txt new file mode 100644 index 0000000000..f6b1108c36 --- /dev/null +++ b/apidocs/src/samples/db-list-user-dbs-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/exampleuser HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-list-user-dbs-request-xml.txt b/apidocs/src/samples/db-list-user-dbs-request-xml.txt new file mode 100644 index 0000000000..77fbe76b26 --- /dev/null +++ b/apidocs/src/samples/db-list-user-dbs-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/testuser HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-list-user-dbs-response-json.txt b/apidocs/src/samples/db-list-user-dbs-response-json.txt new file mode 100644 index 0000000000..54cba76d42 --- /dev/null +++ b/apidocs/src/samples/db-list-user-dbs-response-json.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:11:19 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-list-user-dbs-response-xml.txt b/apidocs/src/samples/db-list-user-dbs-response-xml.txt new file mode 100644 index 0000000000..7032e188d8 --- /dev/null +++ b/apidocs/src/samples/db-list-user-dbs-response-xml.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:11:19 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-list-user-dbs-response.json b/apidocs/src/samples/db-list-user-dbs-response.json new file mode 100644 index 0000000000..928b7733b4 --- /dev/null +++ b/apidocs/src/samples/db-list-user-dbs-response.json @@ -0,0 +1,13 @@ +{ + "user": { + "name": "exampleuser", + "databases": [ + { + "name": "databaseA" + }, + { + "name": "databaseB" + } + ] + } +} \ No newline at end of file diff --git a/apidocs/src/samples/db-list-user-dbs-response.xml b/apidocs/src/samples/db-list-user-dbs-response.xml new file mode 100644 index 0000000000..6ef9df8c38 --- /dev/null +++ b/apidocs/src/samples/db-list-user-dbs-response.xml @@ -0,0 +1,7 @@ + + + + + + diff --git a/apidocs/src/samples/db-list-users-pagination-request-json.txt b/apidocs/src/samples/db-list-users-pagination-request-json.txt new file mode 100644 index 0000000000..7a994d19dd --- /dev/null +++ b/apidocs/src/samples/db-list-users-pagination-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users?limit=2 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-list-users-pagination-request-xml.txt b/apidocs/src/samples/db-list-users-pagination-request-xml.txt new file mode 100644 index 0000000000..c423b642aa --- /dev/null +++ b/apidocs/src/samples/db-list-users-pagination-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/users?limit=2 HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-list-users-pagination-response-json.txt b/apidocs/src/samples/db-list-users-pagination-response-json.txt new file mode 100644 index 0000000000..20cfabf6c7 --- /dev/null +++ b/apidocs/src/samples/db-list-users-pagination-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 279 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-list-users-pagination-response-xml.txt b/apidocs/src/samples/db-list-users-pagination-response-xml.txt new file mode 100644 index 0000000000..a0658bf43d --- /dev/null +++ b/apidocs/src/samples/db-list-users-pagination-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 461 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-list-users-pagination-response.json b/apidocs/src/samples/db-list-users-pagination-response.json new file mode 100644 index 0000000000..faea99a459 --- /dev/null +++ b/apidocs/src/samples/db-list-users-pagination-response.json @@ -0,0 +1,25 @@ +{ + "links": [ + { + "href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users?marker=dbuser2&limit=2", + "rel": "next" + } + ], + "users": [ + { + "databases": [], + "name": "dbuser1" + }, + { + "databases": [ + { + "name": "databaseB" + }, + { + "name": "databaseC" + } + ], + "name": "dbuser2" + } + ] +} diff --git a/apidocs/src/samples/db-list-users-pagination-response.xml b/apidocs/src/samples/db-list-users-pagination-response.xml new file mode 100644 index 0000000000..ced95cb366 --- /dev/null +++ b/apidocs/src/samples/db-list-users-pagination-response.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + diff --git a/apidocs/src/samples/db-list-users-request-json.txt b/apidocs/src/samples/db-list-users-request-json.txt new file mode 100644 index 0000000000..eed67ef77e --- /dev/null +++ b/apidocs/src/samples/db-list-users-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-list-users-request-xml.txt b/apidocs/src/samples/db-list-users-request-xml.txt new file mode 100644 index 0000000000..9eafcef2a7 --- /dev/null +++ b/apidocs/src/samples/db-list-users-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/users HTTP/1.1 +User-Agent: python-reddwarfclient +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-list-users-response-json.txt b/apidocs/src/samples/db-list-users-response-json.txt new file mode 100644 index 0000000000..1878d719d5 --- /dev/null +++ b/apidocs/src/samples/db-list-users-response-json.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 228 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-list-users-response-xml.txt b/apidocs/src/samples/db-list-users-response-xml.txt new file mode 100644 index 0000000000..e7aed7bfc4 --- /dev/null +++ b/apidocs/src/samples/db-list-users-response-xml.txt @@ -0,0 +1,6 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Via: 1.1 Repose (Repose/2.6.7) +Content-Length: 468 +Date: Mon, 18 Mar 2013 19:09:17 GMT +Server: Jetty(8.0.y.z-SNAPSHOT) \ No newline at end of file diff --git a/apidocs/src/samples/db-list-users-response.json b/apidocs/src/samples/db-list-users-response.json new file mode 100644 index 0000000000..c2650d4676 --- /dev/null +++ b/apidocs/src/samples/db-list-users-response.json @@ -0,0 +1,31 @@ +{ + "users": [ + { + "databases": [], + "name": "dbuser1" + }, + { + "databases": [ + { + "name": "databaseB" + }, + { + "name": "databaseC" + } + ], + "name": "dbuser2" + }, + { + "databases": [], + "name": "dbuser3" + }, + { + "databases": [ + { + "name": "sampledb" + } + ], + "name": "demouser" + } + ] +} diff --git a/apidocs/src/samples/db-list-users-response.xml b/apidocs/src/samples/db-list-users-response.xml new file mode 100644 index 0000000000..1f1640fcd6 --- /dev/null +++ b/apidocs/src/samples/db-list-users-response.xml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/apidocs/src/samples/db-revoke-user-access-request-json.txt b/apidocs/src/samples/db-revoke-user-access-request-json.txt new file mode 100644 index 0000000000..20f106571f --- /dev/null +++ b/apidocs/src/samples/db-revoke-user-access-request-json.txt @@ -0,0 +1,6 @@ +DELETE /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/exampleuser/databases/databaseC HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-revoke-user-access-request-xml.txt b/apidocs/src/samples/db-revoke-user-access-request-xml.txt new file mode 100644 index 0000000000..0397d7c23d --- /dev/null +++ b/apidocs/src/samples/db-revoke-user-access-request-xml.txt @@ -0,0 +1,6 @@ +DELETE /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/testuser/databases/extradb HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-revoke-user-access-response-json.txt b/apidocs/src/samples/db-revoke-user-access-response-json.txt new file mode 100644 index 0000000000..af725ba3ae --- /dev/null +++ b/apidocs/src/samples/db-revoke-user-access-response-json.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:11:19 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-revoke-user-access-response-xml.txt b/apidocs/src/samples/db-revoke-user-access-response-xml.txt new file mode 100644 index 0000000000..d6be01e7d0 --- /dev/null +++ b/apidocs/src/samples/db-revoke-user-access-response-xml.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/xml +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:11:19 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-version-request-json.txt b/apidocs/src/samples/db-version-request-json.txt new file mode 100644 index 0000000000..ec5bec35e0 --- /dev/null +++ b/apidocs/src/samples/db-version-request-json.txt @@ -0,0 +1,6 @@ +GET /v1.0/ HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-version-request-xml.txt b/apidocs/src/samples/db-version-request-xml.txt new file mode 100644 index 0000000000..bbca2ecc7f --- /dev/null +++ b/apidocs/src/samples/db-version-request-xml.txt @@ -0,0 +1,6 @@ +GET /v1.0/ HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-version-response-json.txt b/apidocs/src/samples/db-version-response-json.txt new file mode 100644 index 0000000000..61dfc6a329 --- /dev/null +++ b/apidocs/src/samples/db-version-response-json.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 150 +Date: Wed, 25 Jan 2012 21:53:04 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-version-response-xml.txt b/apidocs/src/samples/db-version-response-xml.txt new file mode 100644 index 0000000000..632dc343b4 --- /dev/null +++ b/apidocs/src/samples/db-version-response-xml.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Content-Length: 218 +Date: Wed, 25 Jan 2012 21:53:04 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-version-response.json b/apidocs/src/samples/db-version-response.json new file mode 100644 index 0000000000..fb1e7acbfd --- /dev/null +++ b/apidocs/src/samples/db-version-response.json @@ -0,0 +1,13 @@ +{ + "version": { + "id": "v1.0", + "links": [ + { + "href": "https://ord.databases.api.rackspacecloud.com/v1.0/", + "rel": "self" + } + ], + "status": "CURRENT", + "updated": "2012-01-01T00:00:00Z" + } +} diff --git a/apidocs/src/samples/db-version-response.xml b/apidocs/src/samples/db-version-response.xml new file mode 100644 index 0000000000..e75f01d2bc --- /dev/null +++ b/apidocs/src/samples/db-version-response.xml @@ -0,0 +1,9 @@ + + + + + + diff --git a/apidocs/src/samples/db-versions-request-json.txt b/apidocs/src/samples/db-versions-request-json.txt new file mode 100644 index 0000000000..21dd65f43a --- /dev/null +++ b/apidocs/src/samples/db-versions-request-json.txt @@ -0,0 +1,6 @@ +GET / HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/apidocs/src/samples/db-versions-request-xml.txt b/apidocs/src/samples/db-versions-request-xml.txt new file mode 100644 index 0000000000..223bb81374 --- /dev/null +++ b/apidocs/src/samples/db-versions-request-xml.txt @@ -0,0 +1,6 @@ +GET / HTTP/1.1 +User-Agent: python-example-client +Host: ord.databases.api.rackspacecloud.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/xml +Content-Type: application/xml \ No newline at end of file diff --git a/apidocs/src/samples/db-versions-response-json.txt b/apidocs/src/samples/db-versions-response-json.txt new file mode 100644 index 0000000000..314c6835fe --- /dev/null +++ b/apidocs/src/samples/db-versions-response-json.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 153 +Date: Wed, 25 Jan 2012 21:53:04 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-versions-response-xml.txt b/apidocs/src/samples/db-versions-response-xml.txt new file mode 100644 index 0000000000..1e4445d4f5 --- /dev/null +++ b/apidocs/src/samples/db-versions-response-xml.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/xml +Content-Length: 261 +Date: Wed, 25 Jan 2012 21:53:04 GMT \ No newline at end of file diff --git a/apidocs/src/samples/db-versions-response.json b/apidocs/src/samples/db-versions-response.json new file mode 100644 index 0000000000..4cd81df93a --- /dev/null +++ b/apidocs/src/samples/db-versions-response.json @@ -0,0 +1,15 @@ +{ + "versions": [ + { + "id": "v1.0", + "links": [ + { + "href": "https://ord.databases.api.rackspacecloud.com/v1.0/", + "rel": "self" + } + ], + "status": "CURRENT", + "updated": "2012-01-01T00:00:00Z" + } + ] +} diff --git a/apidocs/src/samples/db-versions-response.xml b/apidocs/src/samples/db-versions-response.xml new file mode 100644 index 0000000000..5af9960933 --- /dev/null +++ b/apidocs/src/samples/db-versions-response.xml @@ -0,0 +1,9 @@ + + + + + + + + diff --git a/apidocs/src/xsd/common.ent b/apidocs/src/xsd/common.ent new file mode 100644 index 0000000000..b8972274d6 --- /dev/null +++ b/apidocs/src/xsd/common.ent @@ -0,0 +1,72 @@ + + + + +GET'> +PUT'> +POST'> +DELETE'> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + '> + + + + + + '> + + + + + + '> diff --git a/apidocs/src/xsd/dbaas.wadl b/apidocs/src/xsd/dbaas.wadl new file mode 100644 index 0000000000..89fe424627 --- /dev/null +++ b/apidocs/src/xsd/dbaas.wadl @@ -0,0 +1,2022 @@ + + + %common; + + +]> + + + + + + + + + + + + + + + The account ID of the owner of the specified + instance. + + + + + + + + The instance ID for the specified + database instance. + + + + + + + + + + + + + + The name for the specified + database. + + + + + + + + + + + The name for the specified + user. + + + + + + + + + The name for the specified + database. + + + + + + + + + + + + + + + + + + The flavor ID for the specified + flavor. + + + + + + + + + + + + + Returns detailed information about + the specified version of the API. + This operation returns detailed information about + the specified version of the API. + + + + + The + following examples show the List Version + Details requests: + + + + + + + + + + + + + The + following examples show the List Version + Details responses: + + + + + + + + + + + + &commonFaults; &getFaults; + + + + Lists information about all + versions of the API. + This operation lists information about all versions + of the API. + + + + + The + following examples show the List Versions + requests: + + + + + + + + + + + + + The + following examples show the List Versions + responses: + + + + + + + + + + + &commonFaults; &getFaults; + + + + + Creates a new database + instance. + This operation asynchronously provisions a new + database instance. This call requires the user to + specify a flavor and a + volume size. The service + then provisions the instance with the requested flavor + and sets up a volume of the specified size, which is + the storage for the database instance. + Notes + + You can create only one database + instance per POST + request. + + + You can create a database instance with + one or more databases, and users + associated to those databases. + + + The default binding for the MySQL + instance is port 3306. + + + The following table lists the required and optional + attributes for Create Instance: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Required and Optional Attributes for Create + Instance
Applies ToNameDescriptionRequired
InstanceflavorRefReference (href) to a + flavor as specified in the response + from the List Flavors API call. This + is the actual URI as specified by the + href field in the link. Refer to the + List Flavors response examples that + follow for an example of the + flavorRef. + Rather than the flavor URI, + you can also pass the flavor id + (integer) as the value for + flavorRef. + Refer to for details.Yes
(volume) sizeSpecifies the volume size in + gigabytes (GB). The value specified must + be between 1 and 50.Yes
nameName of the instance to + create. The length of the name is limited + to 255 characters and any characters are + permitted.No
DatabasenameSpecifies + database names + for creating databases on instance + creation. Refer to for the required xml/json format.No
character_setSet of symbols and encodings. + The default character set is + utf8.No
collateSet of rules for comparing + characters in a character set. The default + value for collate is + utf8_general_ci.No
UsernameSpecifies user name for the + database on instance creation. Refer to + for the required xml/json format.No
passwordSpecifies password for those + users on instance creation. Refer to for the required xml/json format.No
(database) nameSpecifies names of databases + that those users can access on instance + creation. Refer to for the required xml/json format.No
+ Refer to + for a list of possible database instance statuses that + may be returned. +
+ + + + The + following examples show the Create Database + Instance requests and responses: + + + + + + + + + + + + + + + + + + + + + + + For + convenience, notice in the response examples + above that resources contain links to + themselves. This allows a client to easily + obtain resource URIs rather than to construct + them. There are two kinds of link relations + associated with resources. A self + link contains a versioned + link to the resource. These links should be + used in cases where the link will be followed + immediately. A bookmark link + provides a permanent link to a resource that + is appropriate for long term storage. + + + &commonFaults; &getFaults;
+ + + + Deletes the specified database + instance. + This operation deletes the specified database + instance, including any associated data. + Refer to + for a list of possible database instance statuses that + may be returned. + This operation is not allowed when the + instance status is + BUILD. + + + + + The + following examples show the Delete Database + Instance requests: + + + + + + + + + + &commonFaults; + + + The + following examples show the Delete Database + Instance responses: + + + + + + + + + &getFaults; + + + + Lists the status and information + for all database instances. + This operation lists the status and information for + all database instances. + Refer to + for a list of possible database instance statuses that + may be returned. + + + + + The + following examples show the List All Database + Instances Detail requests: + + + + + + + + + + + + + The + following examples show the List All Database + Instances responses: + + + + + + + + + + + &commonFaults; &getFaults; + + + + + Lists status and details for a + specified database instance. + This operation lists the status and details of the + specified database instance. + This operation lists the volume size in gigabytes + (GB) and the approximate GB used. + After instance creation, the used + size of your volume will be greater than 0. This + is expected and due to the automatic creation of + non-empty transaction logs for mysql optimization. + The used attribute is + not returned in the + response when the status for the instance is + BUILD, REBOOT, RESIZE, or ERROR. + + Refer to + for a list of possible database instance statuses that + may be returned. + The list operations return a DNS-resolvable hostname + associated with the database instance instead of an IP + address. Since the hostname always resolves to the + correct IP address of the database instance, this + relieves the user from the task of maintaining the + mapping. Note that although the IP address may likely + change on resizing, migrating, and so forth, the + hostname always resolves to the correct database + instance. + + + + + The + following examples show the List Database + Instance Status and Details requests: + + + + + + + + + + + + + The + following examples show the List Database + Instance Status and Details responses: + + + + + + + + + + + &commonFaults; &getFaults; + + + + + Restart the database service on the + instance. + The restart operation restarts only the MySQL + instance. Restarting MySQL erases any dynamic + configuration settings that you have made within + MySQL. + The MySQL service is unavailable until the + instance restarts. + This operation returns a 202 Accepted + response. + + + + + The + following examples show the Restart Instance + requests: + + + + + + + + + + + + + + + The + following examples show the Restart Instance + responses: + + + + + + + + + &commonFaults; &getFaults; &postPutFaults; + + + + Resize the memory of the + instance. + This operation changes the memory size of the + instance, assuming a valid flavorRef is provided. + Restarts MySQL in the process. + + + + + The + following examples show the Resize Instance + requests: + + + + + + + + + + + + + + + The + following examples show the Resize Instance + responses: + + + + + + + + + &commonFaults; &getFaults; &postPutFaults; + + + + Resize the + volume attached to the + Instance. + This operation supports resizing the attached volume + for an instance. It supports only increasing the + volume size and does not support decreasing the size. + The volume size is in gigabytes (GB) and must be an + integer. + You cannot increase the volume to a size + larger than the API volume size limit + specifies. + This operation returns a 202 Accepted + response. + + + + + The + following examples show the Resize Instance + Volume requests: + + + + + + + + + + + + + + + The + following examples show the Resize Instance + Volume responses: + + + + + + + + + &commonFaults; &getFaults; &postPutFaults; + + + + + Creates a new + database within the + specified instance. + This operation creates a new database within the + specified instance. + The name of the database is a required + attribute. + The following additional attributes can be specified + for each database: collate and + character_set. + + + + + + + + + + + + + + + + + + + + + + + + + + +
Required and Optional Attributes for Create + Database
NameDescriptionRequired
nameSpecifies the database name + for creating the database. Refer to the + request examples for the required xml/json + format.Yes
character_setSet of symbols and encodings. + The default character set is + utf8.No
collateSet of rules for comparing + characters in a character set. The default + value for collate is + utf8_general_ci.No
+ See the MySQL documentation for information about + supported character sets and collations at http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html. + The following database names are reserved and + cannot be used for creating databases: lost+found, + information_schema, and mysql. + Refer to the following tables for information about + characters that are valid/invalid for creating + database names. + + + + + + + + + + + + + + + + + + + + + + +
Valid Characters That Can Be Used in a + Database Name
Character
Letters (upper and lower cases + allowed)
Numbers
'@', '?', '#', and spaces are allowed, but + not at the + beginning and end of the database + name
'_' is allowed anywhere in the database + name
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Characters That Cannot + Be Used in a Database Name
Character
Single quotes
Double quotes
Back quotes
Semicolons
Commas
Backslashes
Forward slashes
+ + + + + + + + + + + + + + +
Length Restrictions for Database + Name
RestrictionValue
Database-name maximum length64
+
+ + + + The + following examples show the Create Database + requests: + + + + + + + + + + + + + + + The + following examples show the Create Database + responses: + + + + + + + + + &commonFaults; &getFaults;
+ + + + + Lists databases for the specified + instance. + This operation lists the databases for the specified + instance. + This operation returns only the user-defined + databases, not the system databases. The system + databases (mysql, information_schema, lost+found) + can only be viewed by a database + administrator. + + + + + The + following examples show the List Databases for + Instance requests: + + + + + + + + + + + + The + following examples show the + paginated List + Databases for Instance requests: + + + + + + + + + + + + + The + following examples show the List Databases for + Instance responses: + + + + + + + + + + + + + + The + following examples show the + paginated List + Databases for Instance responses: + + + + + + + + + + + &commonFaults; &getFaults; + + + + Deletes the specified + database. + This operation deletes the requested database within + the specified database instance. Note that all data + associated with the database is also deleted. + + + + + The + following examples show the Delete Database + requests: + + + + + + + + + + + + + The + following examples show the Delete Database + responses: + + + + + + + + + &commonFaults; &getFaults; + + + + + Creates a user for the specified + database instance. + This operation asynchronously provisions a new user + for the specified database instance based on the + configuration defined in the request object. Once the + request is validated and progress has started on the + provisioning process, a 202 Accepted response object + is returned. + Writer: please add the following note back into + the doc once the List User Details call is added back + into the API: Using the identifier, the caller can + check on the progress of the operation by performing a + GET on users/name (for more details on this operation + see the "List User Details" section of this + document). + If the corresponding request cannot be fulfilled due + to insufficient or invalid data, an HTTP 400 "Bad + Request" error response is returned with information + regarding the nature of the failure. Failures in the + validation process are non-recoverable and require the + caller to correct the cause of the failure and POST + the request again. + The following table lists the required attributes + for Create User. Refer to the request examples for the + required xml/json format: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Required Attributes for Create User
Applies ToNameDescriptionRequired
UsernameName of the user for the + database.Yes
passwordUser password for database + access.Yes
(database) nameName of the database + that the user can access. One or more + database names must be + specified.No
+ Notes + + A user is granted all privileges on the + specified databases. + + + The following user name is reserved and + cannot be used for creating users: + root. + + + Refer to the following tables for information about + characters that are valid/invalid for creating + database names, user names, and passwords. + + + + + + + + + + + + + + + + + + + + + + +
Valid Characters That Can Be Used in a + Database Name, User Name, and Password
Character
Letters (upper and lower cases + allowed)
Numbers
'@', '?', '#', and spaces are allowed, but + not at the + beginning and end of the database name, + user name, and password
"_" is allowed anywhere in the database + name, user name, and password
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Characters That Cannot + Be Used in a Database Name, User Name, and + Password
Character
Single quotes
Double quotes
Back quotes
Semicolons
Commas
Backslashes
Forward slashes
Spaces at the front or end of the user + name or password
+ + + + + + + + + + + + + + + + + + + + + + +
Length Restrictions for Database Name, User + Name, and Password
RestrictionValue
Database name maximum length64
User name maximum length16
Password maximum lengthunlimited (no restrictions)
+
+ + + + The + following examples show the Create User + requests: + + + + + + + + + + + + + + + The + following examples show the Create User + responses: + + + + + + + + + &commonFaults; &getFaults;
+ + + + + Lists the users in the specified + database instance. + This operation lists the users in the specified + database instance, along with the associated databases + for that user. + This operation does not return the system + users (database administrators that administer the + health of the database). Also, this operation + returns the "root" user only if "root" user has + been enabled. + The following notes apply to MySQL users: + + + User names can be up to 16 characters + long. + + + When you create accounts with INSERT, you + must use FLUSH PRIVILEGES to tell the server + to reload the grant tables. + + + For additional information, refer to: http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html + + + + + + + The + following examples show the List Users in + Database Instance requests: + + + + + + + + + + + + The + following examples show the + paginated List Users + in Database Instance requests: + + + + + + + + + + + + + + The + following examples show the List Users in + Database Instance responses: + + + + + + + + + + + + + + The + following examples show the + paginated List Users + in Database Instance responses: + + + + + + + + + + + + &commonFaults; &getFaults; + + + + Changes the MySQL password of one + or more users. + This operation changes the MySQL password of one or + more users. + For information about choosing a valid + password, please refer to for details. + + + + + The + following examples show the Change User(s) + Password requests: + + + + + + + + + + + + + + + + The + following examples show the Change User(s) + Password responses: + + + + + + + + + &commonFaults; &getFaults; + + + + + Deletes the user identified by + {name} for the specified database instance. + This operation deletes the specified user for the + specified database instance. + There is a bug in a python library that + development is using that may cause incorrect user + deletions to occur if a period (.) is used in the + user name. In this case, the user name is + truncated to remove the portion of the name from + the period to the end, leaving only the portion + from the beginning up to the period. For example, + for a user named "my.userA", the bug would + truncate the user name to "my", and if the user + "my" exists, that user will be incorrectly + deleted. To avoid the problem, do not use periods + in user names. + + + + + The + following examples show the Delete User + requests: + + + + + + + + + + + + + The + following examples show the Delete User + responses: + + + + + + + + + &commonFaults; &getFaults; + + + + Lists the specified user's name and + a list of databases that the user can access. + This operation lists the specified user's name and a + list of databases that the user can access. + + + + + The + following examples show the List User + requests: + + + + + + + + + + + + + The + following examples show the List User + responses: + + + + + + + + + + + &commonFaults; &getFaults; + + + + Shows a list of all databases a + user has access to. + This operation shows a list of all databases a user + has access to. + + + + + The + following examples show the List User Access + requests: + + + + + + + + + + + + + The + following examples show the List User Access + responses: + + + + + + + + + + + &commonFaults; &getFaults; + + + + Grant access for the specified user + to one or more databases for the specified + instance. + This operation grants access for the specified user + to one or more databases for the specified instance. + The user is granted ALL privileges on the database. + Refer to the information at the beginning of for more details on + access. + + + + + The + following examples show the Grant User Access + requests: + + + + + + + + + + + + + + + The + following examples show the Grant User Access + responses: + + + + + + + + + &commonFaults; &getFaults; + + + + Remove access to the specified + database for the specified user. + This operation removes access to the specified + database for the specified user. + + + + + The + following examples show the Revoke User Access + requests: + + + + + + + + + + + + + The + following examples show the Revoke User Access + responses: + + + + + + + + + &commonFaults; &getFaults; + + + + + Enables the root user for the + specified database instance and returns the root + password. + This operation enables login from any host for the + root user and provides the user with a generated root + password. + Changes you make as a root user may cause + detrimental effects to the database instance and + unpredictable behavior for API operations. When + you enable the root user, you accept the + possibility that we will not be able to support + your database instance. While enabling root does + not prevent us from a “best effort” approach to + helping you if something goes wrong with your + instance, we cannot ensure that we will be able to + assist you if you change core MySQL settings. + These changes can be (but are not limited to) + turning off binlogs, removing users that we use to + access your instance, and so forth. + + + + + The + following examples show the Enable Root User + requests: + + + + + + + + + + + + + The + following examples show the Enable Root User + responses: + + + + + + + + + + + + &commonFaults; &getFaults; + + + + Returns true if root user is + enabled for the specified database instance or false + otherwise. + This operation checks an active specified database + instance to see if root access is enabled. It returns + True if root user is enabled for the specified + database instance or False otherwise. + + + + + The + following examples show the Check Root User + Access requests: + + + + + + + + + + + + + The + following examples show the Check Root User + Access responses: + + + + + + + + + + + &commonFaults; &getFaults; + + + + + Lists information for all available + flavors. + This operation lists information for all available + flavors. + This resource is identical to the flavors found in + the OpenStack Nova API, but without the disk + property. + + + + + The + following examples show the List Flavors + requests: + + + + + + + + + + + + + The + following examples show the List Flavors + responses: + + + + + + + + + + + &commonFaults; &getFaults; + + + + Lists all flavor information about + the specified flavor ID. + This operation lists all information for the + specified flavor ID with details of the RAM. + This resource is identical to the flavors found in + the OpenStack Nova API, but without the disk + property. + The flavorId parameter should be an integer. + If a floating point value is used for the flavorId + parameter, the decimal portion is truncated and + the integer portion is used as the value of the + flavorId. + Reviewer / Writer: need to + confirm that this behavior is not changed in + subsequent releases, and if it is prevented, remove + the Note above. + + + + + The + following examples show the List Flavor By ID + requests: + + + + + + + + + + + + + The + following examples show the List Flavor By ID + responses: + + + + + + + + + + + &commonFaults; &getFaults; +
diff --git a/apidocs/src/xsd/dbaas.xsd b/apidocs/src/xsd/dbaas.xsd new file mode 100644 index 0000000000..06f05f64b3 --- /dev/null +++ b/apidocs/src/xsd/dbaas.xsd @@ -0,0 +1,615 @@ + + + + + + + + DBaaS + + +

+ This is the main index XML Schema document + for DBaaS API Schema Types Version 1.0. +

+
+
+ + + + +

A MySQL User.

+
+
+
+ + + +

A MySQL User.

+
+
+
+ + + +

A Database Instance.

+
+
+
+ + + +

Database Instances.

+
+
+
+ + + +

Settings such as memory used to create a database instance.

+
+
+
+ + + +

A list of flavors.

+
+
+
+ + + +

A Database.

+
+
+
+ + + +

List of Databases.

+
+
+
+ + + +

Restart the Database

+
+
+
+ + + +

Resize an Instance

+
+
+
+ + + + + + + +

A list of database user names.

+
+
+
+
+
+ + + + + + +

A list of databases.

+
+
+
+
+ + + +

The name for the user.

+
+
+
+ + + +

The password for the user.

+
+
+
+ + + +

The status of the user.

+
+
+
+
+ + + + + + +

A list of database instances.

+
+
+
+
+
+ + + + + + +

A list of optional databases.

+
+
+
+ + + +

A list of optional users.

+
+
+
+ + + +

The links for the type of instance.

+
+
+
+ + + +

The volume attached to the instance.

+
+
+
+
+ + + +

A unique database instance id.

+
+
+
+ + + +

Date/Time the instance was created.

+
+
+
+ + + +

Date/Time the instance was last updated.

+
+
+
+ + + +

The name for the instance.

+
+
+
+ + + +

The flavor reference of the instance.

+
+
+
+ + + +

The status of the instance.

+
+
+
+ + + +

The hostname attached to the instance.

+
+
+
+ + + +

Whether or not root is enabled for the instance.

+
+
+
+
+ + + + + +

The type of link.

+
+
+
+ + + +

The URL.

+
+
+
+ + + +

The type of link.

+
+
+
+
+ + + + + + +

A list of flavors.

+
+
+
+
+
+ + + + + + +

A list of links.

+
+
+
+
+ + + +

A unique flavor id.

+
+
+
+ + + +

The name for the instance.

+
+
+
+ + + +

The RAM in megabytes.

+
+
+
+
+ + + + + + +

A list of links.

+
+
+
+
+
+ + + + + + +

A list of databases.

+
+
+
+
+
+ + + + + +

The Database character set.

+
+
+
+ + + +

The name for the instance.

+
+
+
+ + + +

The Collation type of the database.

+
+
+
+
+ + + + + +

Whether or not root is enabled for the given instance.

+
+
+
+
+ + + + + +

Size of the volume in GBs.

+
+
+
+ + + +

Used space on the attached volume in GBs.

+
+
+
+
+ + + + + +

A unique flavor id.

+
+
+
+
+ + + + + + +

The volume attached to the instance.

+
+
+
+ + + +

New flavorRef to size the instance.

+
+
+
+
+
+ + + + + +

The instance status.

+
+
+ + + + +

Healthy status.

+
+
+
+ + + +

Down status.

+
+
+
+ + + +

unavailable status.

+
+
+
+
+
+ + + + +

The mysql user status.

+
+
+ + + + +

Enabled status.

+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + +

+ 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/apidocs/src/xslts/js/shjs/sh_java.js b/apidocs/src/xslts/js/shjs/sh_java.js new file mode 100644 index 0000000000..731fc9f340 --- /dev/null +++ b/apidocs/src/xslts/js/shjs/sh_java.js @@ -0,0 +1,337 @@ +if (! this.sh_languages) { + this.sh_languages = {}; +} +sh_languages['java'] = [ + [ + [ + /\b(?:import|package)\b/g, + 'sh_preproc', + -1 + ], + [ + /\/\/\//g, + 'sh_comment', + 1 + ], + [ + /\/\//g, + 'sh_comment', + 7 + ], + [ + /\/\*\*/g, + 'sh_comment', + 8 + ], + [ + /\/\*/g, + 'sh_comment', + 9 + ], + [ + /\b[+-]?(?:(?:0x[A-Fa-f0-9]+)|(?:(?:[\d]*\.)?[\d]+(?:[eE][+-]?[\d]+)?))u?(?:(?:int(?:8|16|32|64))|L)?\b/g, + 'sh_number', + -1 + ], + [ + /"/g, + 'sh_string', + 10 + ], + [ + /'/g, + 'sh_string', + 11 + ], + [ + /(\b(?:class|interface))([ \t]+)([$A-Za-z0-9_]+)/g, + ['sh_keyword', 'sh_normal', 'sh_classname'], + -1 + ], + [ + /\b(?:abstract|assert|break|case|catch|class|const|continue|default|do|else|extends|false|final|finally|for|goto|if|implements|instanceof|interface|native|new|null|private|protected|public|return|static|strictfp|super|switch|synchronized|throw|throws|true|this|transient|try|volatile|while)\b/g, + 'sh_keyword', + -1 + ], + [ + /\b(?:int|byte|boolean|char|long|float|double|short|void)\b/g, + 'sh_type', + -1 + ], + [ + /~|!|%|\^|\*|\(|\)|-|\+|=|\[|\]|\\|:|;|,|\.|\/|\?|&|<|>|\|/g, + 'sh_symbol', + -1 + ], + [ + /\{|\}/g, + 'sh_cbracket', + -1 + ], + [ + /(?:[A-Za-z]|_)[A-Za-z0-9_]*(?=[ \t]*\()/g, + 'sh_function', + -1 + ], + [ + /([A-Za-z](?:[^`~!@#$%&*()_=+{}|;:",<.>\/?'\\[\]\^\-\s]|[_])*)((?:<.*>)?)(\s+(?=[*&]*[A-Za-z][^`~!@#$%&*()_=+{}|;:",<.>\/?'\\[\]\^\-\s]*\s*[`~!@#$%&*()_=+{}|;:",<.>\/?'\\[\]\^\-\[\]]+))/g, + ['sh_usertype', 'sh_usertype', 'sh_normal'], + -1 + ] + ], + [ + [ + /$/g, + null, + -2 + ], + [ + /(?:?)|(?:?)/g, + 'sh_url', + -1 + ], + [ + /<\?xml/g, + 'sh_preproc', + 2, + 1 + ], + [ + //g, + 'sh_keyword', + -1 + ], + [ + /<(?:\/)?[A-Za-z](?:[A-Za-z0-9_:.-]*)/g, + 'sh_keyword', + 6, + 1 + ], + [ + /&(?:[A-Za-z0-9]+);/g, + 'sh_preproc', + -1 + ], + [ + /<(?:\/)?[A-Za-z][A-Za-z0-9]*(?:\/)?>/g, + 'sh_keyword', + -1 + ], + [ + /<(?:\/)?[A-Za-z][A-Za-z0-9]*/g, + 'sh_keyword', + 6, + 1 + ], + [ + /@[A-Za-z]+/g, + 'sh_type', + -1 + ], + [ + /(?:TODO|FIXME|BUG)(?:[:]?)/g, + 'sh_todo', + -1 + ] + ], + [ + [ + /\?>/g, + 'sh_preproc', + -2 + ], + [ + /([^=" \t>]+)([ \t]*)(=?)/g, + ['sh_type', 'sh_normal', 'sh_symbol'], + -1 + ], + [ + /"/g, + 'sh_string', + 3 + ] + ], + [ + [ + /\\(?:\\|")/g, + null, + -1 + ], + [ + /"/g, + 'sh_string', + -2 + ] + ], + [ + [ + />/g, + 'sh_preproc', + -2 + ], + [ + /([^=" \t>]+)([ \t]*)(=?)/g, + ['sh_type', 'sh_normal', 'sh_symbol'], + -1 + ], + [ + /"/g, + 'sh_string', + 3 + ] + ], + [ + [ + /-->/g, + 'sh_comment', + -2 + ], + [ + //g, + 'sh_comment', + -2 + ], + [ + //g, + 'sh_comment', + -2 + ], + [ + / array of links + // + // possible types include: import, include, element, + // attribute, complextype, simpleType + // + // each link contains the following properties: + // name : the name of the link + // href : the link itself + // title : a description of the link + links : new Object(), + + // + // A single link that points to the schema index document. + // + index : null, + + // + // Our initialization function + // + _init : function() { + // + // Load the menu... + // + var controllerDiv = document.getElementById("Controller"); + var mainMenu = this._menuMarkup("mainmenu"); + + for (var linkType in this.links) + { + var subItem = this._menuItemMarkup(mainMenu, linkType, "#", null); + var subMenu = this._menuMarkup (linkType+"_subMenu"); + + var items = this.links[linkType]; + for (var i=0;i Array of sample ids. + // + samples : new Object(), + + // + // An array of code data.. + // + // Code data is defined as an object with the following + // properties: + // + // type: The mimetype of the code...href: The location of the code + // or null if it's inline + // + // id: The id of the pre that contains the code. + // + // The initial object is the source code for the current document. + // + codes : new Array({ + id : "SrcContentCode", + type : "application/xml", + href : (function() { + var ret = location.href; + if (location.hash && (location.hash.length != 0)) + { + ret = ret.replace (location.hash, ""); + } + return ret; + })() + }), + + // + // Sets up the manager, begins the loading process... + // + _init : function() { + // + // Setup an array to hold data items to load, this is used by + // the loadSample method. + // + this._toLoad = new Array(); + + for (var i=0;i -1) && + (ieVersion < 8)) + { + code = trc.util.text.unix2dos (code); + } + + var pre = document.getElementById(codeData.id); + var preNodes = pre.childNodes; + // + // Remove placeholder data... + // + while (preNodes.length != 0) + { + pre.removeChild (preNodes[0]); + } + + // + // Set the correct class type... + // + switch (codeData.type) + { + /* + Javascript mimetypes + */ + case 'application/json': + case 'application/javascript': + case 'application/x-javascript': + case 'application/ecmascript': + case 'text/ecmascript': + case 'text/javascript': + trc.util.dom.setClassName (pre, "sh_javascript"); + break; + /* + Not real mimetypes but this is what we'll use for Java. + */ + case 'application/java': + case 'text/java': + trc.util.dom.setClassName (pre, "sh_java"); + break; + default: + trc.util.dom.setClassName (pre, "sh_xml"); + break; + } + + // + // Add new code... + // + pre.appendChild (document.createTextNode (code)); + }, + + // + // Retrives source code text + // + _getCodeText : function (codeData /* Info for the code to get*/) + { + var pre = document.getElementById(codeData.id); + pre.normalize(); + // + // Should be a single text node after pre... + // + return pre.firstChild.nodeValue; + }, + + + // + // Normalizes text by ensuring that top, bottom, right indent + // levels are equal for all samples. + // + _normalizeCodeText : function (top, /* integer, top indent in lines */ + bottom, /* integer, bottom indent in lines */ + right /* integer, right indent in spaces */ + ) + { + for (var i=0;i -1) && + (ieVersion < 7)) + { + element.className = name; + } + else + { + element.setAttribute ("class",name); + } + } +}; + +trc.util.text = { + // + // Useful RegExps + // + blank : new RegExp ("^\\s*$"), /* A blank string */ + indent : new RegExp ("^\\s+"), /* Line indent */ + lines : new RegExp ("$","m"), /* All lines */ + linechars : new RegExp ("(\n|\r)"), /* EOL line characters */ + tabs : new RegExp ("\t","g"), /* All tabs */ + + // + // We need this because microsoft browsers before IE 7, connot + // display pre-formatted text correctly win unix style line + // endings. + // + unix2dos : function(txt /* String */) { + //if already DOS... + if (txt.search(/\r\n/) != -1) + { + return txt; + } + return txt.replace (/\n/g, "\r\n"); + }, + + // + // Useful to normalize text. + // + dos2unix : function(txt /* String */) { + //if already unix... + if (txt.search(/\r\n/) == -1) + { + return txt; + } + + return txt.replace(/\r/g, ""); + }, + + // + // Create a string with a character repeated x times. + // + repString : function (length, /* integer, size of the string to create */ + ch /* string, The character to set the string to */ + ) + { + var ret = new String(); + for (var i=0;idep. + // + _deps : new Object(), + + // + // An array of callback functions, these should be called when all + // dependecies are loaded. + // + _callbacks : new Array(), + + // + // The init function simply calls the YUI loader... + // + _init : function() { + var yuiUtil = this; + + // + // It takes safari a while to load the YUI Loader if it hasn't + // loaded yet keep trying at 1/4 second intervals + // + if (!window.YAHOO) + { + window.setTimeout (function() { + yuiUtil._init(); + }, 250); + return; + } + + // + // Collect requirements... + // + var required = new Array(); + for (var req in this._deps) + { + required.push (req); + } + + // + // Load YUI dependecies... + // + var loader = new YAHOO.util.YUILoader({ + require: required, + loadOptional: true, + filter: "RAW", + onSuccess: function() { + yuiUtil._depsLoaded(); + }, + timeout: 10000, + combine: true + }); + loader.insert(); + }, + + // + // Called after all dependecies have been loaded + // + _depsLoaded : function() { + // + // Dependecies are loaded let everyone know. + // + for (var i=0;i, + */ +pre.sh_sourceCode .sh_function { color: black; font-weight: bold; } /* function calls and declarations */ +pre.sh_sourceCode .sh_cbracket { color: red; } /* block brackets (e.g., {, }) */ +pre.sh_sourceCode .sh_todo { font-weight: bold; background-color: cyan; } /* TODO and FIXME */ + +/* Predefined variables and functions (for instance glsl) */ +pre.sh_sourceCode .sh_predef_var { color: darkblue; } +pre.sh_sourceCode .sh_predef_func { color: darkblue; font-weight: bold; } + +/* for OOP */ +pre.sh_sourceCode .sh_classname { color: teal; } + +/* line numbers (not yet implemented) */ +pre.sh_sourceCode .sh_linenum { color: black; font-family: monospace; } + +/* Internet related */ +pre.sh_sourceCode .sh_url { color: blue; text-decoration: underline; font-family: monospace; } + +/* for ChangeLog and Log files */ +pre.sh_sourceCode .sh_date { color: blue; font-weight: bold; } +pre.sh_sourceCode .sh_time, pre.sh_sourceCode .sh_file { color: darkblue; font-weight: bold; } +pre.sh_sourceCode .sh_ip, pre.sh_sourceCode .sh_name { color: darkgreen; } + +/* for Prolog, Perl... */ +pre.sh_sourceCode .sh_variable { color: darkgreen; } + +/* for LaTeX */ +pre.sh_sourceCode .sh_italics { color: darkgreen; font-style: italic; } +pre.sh_sourceCode .sh_bold { color: darkgreen; font-weight: bold; } +pre.sh_sourceCode .sh_underline { color: darkgreen; text-decoration: underline; } +pre.sh_sourceCode .sh_fixed { color: green; font-family: monospace; } +pre.sh_sourceCode .sh_argument { color: darkgreen; } +pre.sh_sourceCode .sh_optionalargument { color: purple; } +pre.sh_sourceCode .sh_math { color: orange; } +pre.sh_sourceCode .sh_bibtex { color: blue; } + +/* for diffs */ +pre.sh_sourceCode .sh_oldfile { color: orange; } +pre.sh_sourceCode .sh_newfile { color: darkgreen; } +pre.sh_sourceCode .sh_difflines { color: blue; } + +/* for css */ +pre.sh_sourceCode .sh_selector { color: purple; } +pre.sh_sourceCode .sh_property { color: blue; } +pre.sh_sourceCode .sh_value { color: darkgreen; font-style: italic; } + +/* other */ +pre.sh_sourceCode .sh_section { color: black; font-weight: bold; } +pre.sh_sourceCode .sh_paren { color: red; } +pre.sh_sourceCode .sh_attribute { color: darkgreen; } diff --git a/apidocs/src/xslts/style/shjs/sh_whitengrey.css b/apidocs/src/xslts/style/shjs/sh_whitengrey.css new file mode 100644 index 0000000000..41df0e2c6d --- /dev/null +++ b/apidocs/src/xslts/style/shjs/sh_whitengrey.css @@ -0,0 +1,139 @@ +pre.sh_sourceCode { + background-color: #ffffff; + color: #696969; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_keyword { + color: #696969; + font-weight: bold; + font-style: normal; +} + +pre.sh_sourceCode .sh_type { + color: #696969; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_string { + color: #008800; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_regexp { + color: #008800; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_specialchar { + color: #008800; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_comment { + color: #1326a2; + font-weight: normal; + font-style: italic; +} + +pre.sh_sourceCode .sh_number { + color: #bb00ff; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_preproc { + color: #470000; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_function { + color: #000000; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_url { + color: #008800; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_date { + color: #696969; + font-weight: bold; + font-style: normal; +} + +pre.sh_sourceCode .sh_time { + color: #696969; + font-weight: bold; + font-style: normal; +} + +pre.sh_sourceCode .sh_file { + color: #696969; + font-weight: bold; + font-style: normal; +} + +pre.sh_sourceCode .sh_ip { + color: #008800; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_name { + color: #008800; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_variable { + color: #696969; + font-weight: bold; + font-style: normal; +} + +pre.sh_sourceCode .sh_oldfile { + color: #008800; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_newfile { + color: #008800; + font-weight: normal; + font-style: normal; +} + +pre.sh_sourceCode .sh_difflines { + color: #696969; + font-weight: bold; + font-style: normal; +} + +pre.sh_sourceCode .sh_selector { + color: #696969; + font-weight: bold; + font-style: normal; +} + +pre.sh_sourceCode .sh_property { + color: #696969; + font-weight: bold; + font-style: normal; +} + +pre.sh_sourceCode .sh_value { + color: #008800; + font-weight: normal; + font-style: normal; +} + diff --git a/apidocs/src/xslts/xslt/.htaccess b/apidocs/src/xslts/xslt/.htaccess new file mode 100644 index 0000000000..2806956cc6 --- /dev/null +++ b/apidocs/src/xslts/xslt/.htaccess @@ -0,0 +1,5 @@ +AddType application/xml wadl +AddType application/xml xsd +AddType application/xml xslt + + diff --git a/apidocs/src/xslts/xslt/schema.xslt b/apidocs/src/xslts/xslt/schema.xslt new file mode 100644 index 0000000000..e8ef717518 --- /dev/null +++ b/apidocs/src/xslts/xslt/schema.xslt @@ -0,0 +1,1330 @@ + + + + + + + + + + + XML Schema Documentation + application/xhtml+xml + http://www.w3.org/2001/XMLSchema + http://web4.w3.org/TR/2001/REC-xmlschema-2-20010502/# + + " + ' + + + + + + + + + + + + + + + + + + + + element_ + attrib_ + attgrp_ + grp_ + type_ + + + + http://yui.yahooapis.com/2.7.0/build/ + + + + + + + + + + + + + + + + + stylesheet + text/css + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <xslt:value-of select="xsd:annotation/xsd:appinfo/xsdxt:title"/> + + + <xslt:value-of select="$defaultTitle"/> + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
Loading...
+
+
+
+ + + +

+
+ +

+
+
+ + + + + + + + + + + +
+ + + + + + + + + +

Namespaces

+ + + +
+

+ Your browser does not seem to have support for + namespace nodes in XPath. If you're a Firefox + user, please consider voting to get this issue + resolved: + + https://bugzilla.mozilla.org/show_bug.cgi?id=94270 + +

+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + + + + trc.schema.controller.links[' + + ']=[ + + + + + + + + + + + + + + + + + + + + + + + + + + , + + + ]; + + + + + + trc.schema.controller.index = + + + + + + index + + + Index Schema Document + + + ; + + + + + + + trc.schema.controller.links[' + + ']=[ + + + + # + + + + + + + + See definition of + + + + + , + + + ]; + + + + + + + + { href : + + + + + + , name : + + + + + + , title : + + + + + + } + + + + + + + + +

Imports

+ + + + + + + + + +
+ + +
+
+ + + Visit + + +
+
+ +
+
+
+
+ + +

Includes

+ + + + + + + + +
+
+
+ + + Visit + + +
+
+ +
+
+
+
+ + +

Elements

+ + + + + + + + +
+ + + + + + +
+
+ + + trc.schema.sampleManager.showSample( + + + + ); + + + + + + + + + + + + + + + + + + + + +
+
+ + + + Sample +
+ +
+ +
+
+
+ + + +
+ + + + + + + Loading... + + + + + + +
+
+ + + + + + +

Complex Types

+ + + + + + +
+ + +

Simple Types

+ + + + + + +
+ + + + + + # + + + + + + + + + + + + + + + + + + +

+ +

+ + + + + +
+ extends: + + + + , + + +
+
+ +
+ restricts: + + + + , + + +
+
+
+
+ + + +
+ + + + + + + + + + SubAttributes + + + Attributes + + + + + + + + + + + + + + + +
+
+
+
+ + + + + + + + + + SubDocumentation + + + Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Sequence + + +
+
+ + + +
+
+
+ +
+ + + +
+ + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + <?> (Any Element) + + + + + + + + @? (Any Attribute) + + + + + +
+ restriction +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
enum values
+ + + + + + + + +
+ + + + + +
+
+ + + (id = + + ) + +
+ +
+ +
+
+
+ +
+ + + + + + + + (id = + + ) + + + (fixed) + + + + + + + + + + + + +
+ +
+ +
+ +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + < + + > + + + + + + @ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
diff --git a/doc-test.conf b/doc-test.conf new file mode 100644 index 0000000000..b7f014d25f --- /dev/null +++ b/doc-test.conf @@ -0,0 +1,11 @@ +[DEFAULT] +repo_name = trove +api_site = True + +# From apidocs +file_exception = includewars.xml + +# These two options need to come as triplets: +book = apidocs +target_dir = target/docbkx/webhelp/cdb-devguide-reviewer +publish_dir = api/openstack-databases diff --git a/test-requirements.txt b/test-requirements.txt index bc3f710a9b..399b2bb7d4 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,6 +6,7 @@ oslosphinx coverage>=3.6 nose nosexcover +openstack-doc-tools>=0.11 openstack.nose_plugin>=0.7 WebTest>=2.0 wsgi_intercept>=0.6.1 # MIT License diff --git a/tox.ini b/tox.ini index 9c4788d55c..df26b41399 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py26,py27,pep8 +envlist = py26,py27,pep8,checkniceness,checksyntax,checkdeletions,checkbuild minversion = 1.6 skipsdist = True @@ -40,3 +40,19 @@ ignore = F821,H301,H306,H402,H404 builtins = _ exclude=.venv,.tox,dist,doc,openstack,*egg,rsdns,tools,etc,build filename=*.py,trove-* + +[testenv:checkniceness] +commands = openstack-doc-test --check-niceness {posargs} + +[testenv:checksyntax] +commands = openstack-doc-test --check-syntax {posargs} + +[testenv:checkdeletions] +commands = openstack-doc-test --check-deletions {posargs} + +[testenv:checkbuild] +commands = openstack-doc-test --check-build {posargs} + +[testenv:publishdocs] +commands = openstack-doc-test --check-build --publish --force +