From c954879308f7dc59ecf07aabd654fce53dd87d06 Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Mon, 7 Apr 2014 15:26:57 -0500 Subject: [PATCH] Add OpenStack Databases (trove) API to api-site Removed XML request and response examples because they are no longer supported Closes-Bug: #1303966 Change-Id: Ice6ee57d22ffb75fbf2e30d2105ff7fb64e7a7cf author: diane fleming --- api-ref-guides/pom.xml | 11 + api-ref-guides/src/bk-api-ref-databases.xml | 21 + api-ref-guides/src/bk-api-ref.xml | 15 +- api-ref/pom.xml | 12 + api-ref/src/docbkx/api-ref-databases.xml | 23 + api-ref/src/docbkx/ch_databases-v1.xml | 156 +++ .../src/docbkx/itemizedlist-service-list.xml | 3 + .../src/wadls/databases-api/xsd/common.ent | 72 + .../src/wadls/databases-api/xsd/dbaas.wadl | 1196 +++++++++++++++++ api-ref/src/wadls/databases-api/xsd/dbaas.xsd | 575 ++++++++ .../db-check-root-user-request-json-http.txt | 6 + .../db-check-root-user-response-json-http.txt | 4 + .../samples/db-check-root-user-response.json | 3 + .../db-create-databases-request-json-http.txt | 6 + .../samples/db-create-databases-request.json | 12 + ...db-create-databases-response-json-http.txt | 4 + .../db-create-instance-request-json-http.txt | 6 + .../samples/db-create-instance-request.json | 30 + .../db-create-instance-response-json-http.txt | 4 + .../samples/db-create-instance-response.json | 36 + .../db-create-users-request-json-http.txt | 6 + .../xsd/samples/db-create-users-request.json | 25 + .../db-create-users-response-json-http.txt | 4 + .../db-delete-databases-request-json-http.txt | 8 + ...db-delete-databases-response-json-http.txt | 4 + .../db-delete-instance-request-json-http.txt | 6 + .../db-delete-instance-response-json-http.txt | 4 + .../db-delete-users-request-json-http.txt | 8 + .../db-delete-users-response-json-http.txt | 4 + .../db-enable-root-user-request-json-http.txt | 8 + ...db-enable-root-user-response-json-http.txt | 4 + .../samples/db-enable-root-user-response.json | 6 + .../db-flavors-by-id-request-json-http.txt | 8 + .../db-flavors-by-id-response-json-http.txt | 4 + .../samples/db-flavors-by-id-response.json | 17 + .../samples/db-flavors-request-json-http.txt | 8 + .../samples/db-flavors-response-json-http.txt | 4 + .../xsd/samples/db-flavors-response.json | 64 + .../db-instance-resize-flavor-request.json | 5 + ...tance-resize-flavor-response-json-http.txt | 4 + ...ance-resize-instance-request-json-http.txt | 6 + .../db-instance-resize-instance-request.json | 5 + ...nce-resize-instance-response-json-http.txt | 6 + ...stance-resize-volume-request-json-http.txt | 6 + .../db-instance-resize-volume-request.json | 7 + ...tance-resize-volume-response-json-http.txt | 4 + .../db-instance-restart-request-json-http.txt | 6 + .../samples/db-instance-restart-request.json | 5 + ...db-instance-restart-response-json-http.txt | 4 + ...stance-status-detail-request-json-http.txt | 6 + ...tance-status-detail-response-json-http.txt | 4 + .../db-instance-status-detail-response.json | 37 + .../db-instances-index-request-json-http.txt | 6 + .../db-instances-index-response-json-http.txt | 4 + .../samples/db-instances-index-response.json | 66 + .../db-list-databases-request-json-http.txt | 8 + .../db-list-databases-response-json-http.txt | 4 + .../samples/db-list-databases-response.json | 19 + .../db-list-users-request-json-http.txt | 8 + .../db-list-users-response-json-http.txt | 4 + .../xsd/samples/db-list-users-response.json | 23 + .../samples/db-version-request-json-http.txt | 6 + .../samples/db-version-response-json-http.txt | 4 + .../xsd/samples/db-version-response.json | 13 + .../samples/db-versions-request-json-http.txt | 6 + .../db-versions-response-json-http.txt | 4 + .../xsd/samples/db-versions-response.json | 15 + pom.xml | 2 - 68 files changed, 2677 insertions(+), 7 deletions(-) create mode 100644 api-ref-guides/src/bk-api-ref-databases.xml create mode 100644 api-ref/src/docbkx/api-ref-databases.xml create mode 100644 api-ref/src/docbkx/ch_databases-v1.xml create mode 100644 api-ref/src/wadls/databases-api/xsd/common.ent create mode 100644 api-ref/src/wadls/databases-api/xsd/dbaas.wadl create mode 100644 api-ref/src/wadls/databases-api/xsd/dbaas.xsd create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-response.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-request.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-request.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-response.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-create-users-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-create-users-request.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-create-users-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-delete-databases-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-delete-databases-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-delete-instance-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-delete-instance-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-delete-users-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-delete-users-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-response.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-response.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-flavors-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-flavors-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-flavors-response.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-flavor-request.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-flavor-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-request.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-request.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-request.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-response.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-response.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-response.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-list-users-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-list-users-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-list-users-response.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-version-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-version-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-version-response.json create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-versions-request-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-versions-response-json-http.txt create mode 100644 api-ref/src/wadls/databases-api/xsd/samples/db-versions-response.json diff --git a/api-ref-guides/pom.xml b/api-ref-guides/pom.xml index 68a32aaee..928da7e3c 100644 --- a/api-ref-guides/pom.xml +++ b/api-ref-guides/pom.xml @@ -82,6 +82,17 @@ api-ref-compute-v3 + + os-api-ref-databases + + generate-pdf + + generate-sources + + bk-api-ref-databases.xml + api-ref-databases + + os-api-ref-identity-v2 diff --git a/api-ref-guides/src/bk-api-ref-databases.xml b/api-ref-guides/src/bk-api-ref-databases.xml new file mode 100644 index 000000000..36587a40c --- /dev/null +++ b/api-ref-guides/src/bk-api-ref-databases.xml @@ -0,0 +1,21 @@ + + + + OpenStack Database Service API + + 2010-2014 + + + + + + + + diff --git a/api-ref-guides/src/bk-api-ref.xml b/api-ref-guides/src/bk-api-ref.xml index d36d8a534..3a8d9afd7 100644 --- a/api-ref-guides/src/bk-api-ref.xml +++ b/api-ref-guides/src/bk-api-ref.xml @@ -32,21 +32,26 @@ - - + + + - + - - + + diff --git a/api-ref/pom.xml b/api-ref/pom.xml index 538f99823..f8b0239f4 100644 --- a/api-ref/pom.xml +++ b/api-ref/pom.xml @@ -93,6 +93,18 @@ bk-api-ref-compute-v3 + + os-api-ref-databases + + generate-html + + generate-sources + + + api-ref-databases.xml + bk-api-ref-databases + + os-api-ref-image diff --git a/api-ref/src/docbkx/api-ref-databases.xml b/api-ref/src/docbkx/api-ref-databases.xml new file mode 100644 index 000000000..e77c257f5 --- /dev/null +++ b/api-ref/src/docbkx/api-ref-databases.xml @@ -0,0 +1,23 @@ + + + + OpenStack Database Service API + + 2010-2014 + + + + + + + + + + diff --git a/api-ref/src/docbkx/ch_databases-v1.xml b/api-ref/src/docbkx/ch_databases-v1.xml new file mode 100644 index 000000000..005f4e583 --- /dev/null +++ b/api-ref/src/docbkx/ch_databases-v1.xml @@ -0,0 +1,156 @@ + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Databases Service API v1.0 +
+ API versions + + + + + + +
+ +
+ Database instances + + + + + + + + + + + + + + +
+
+ Database instance actions + + + + + + + +
+
+ Databases + + + + + + + + + +
+
+ Users + + + + + + + + + +
+
+ Flavors + + + + + + + + +
+ + + + + + diff --git a/api-ref/src/docbkx/itemizedlist-service-list.xml b/api-ref/src/docbkx/itemizedlist-service-list.xml index 0e054d551..925928c5c 100644 --- a/api-ref/src/docbkx/itemizedlist-service-list.xml +++ b/api-ref/src/docbkx/itemizedlist-service-list.xml @@ -21,6 +21,9 @@ Compute API v3 (EXPERIMENTAL) + + Database Service API + Identity API v2.0 and extensions diff --git a/api-ref/src/wadls/databases-api/xsd/common.ent b/api-ref/src/wadls/databases-api/xsd/common.ent new file mode 100644 index 000000000..b8972274d --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/common.ent @@ -0,0 +1,72 @@ + + + + +GET'> +PUT'> +POST'> +DELETE'> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + '> + + + + + + '> + + + + + + '> diff --git a/api-ref/src/wadls/databases-api/xsd/dbaas.wadl b/api-ref/src/wadls/databases-api/xsd/dbaas.wadl new file mode 100644 index 000000000..7b3b50444 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/dbaas.wadl @@ -0,0 +1,1196 @@ + + + %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 flavor ID for + the specified + flavor. + + + + + + + + + + + + Shows details for a specified API + version. + Reviewer: in the DNS project, we have been + requested by the customer to provide a table of + parameters (should be pulled automatically if parms + defined in wadl) and a table of attributes (for calls + that allow detailed info about the object created to + be specified. No doubt our DB customers will want this + too. + Reviewer: These tables probably need 4 columns: + name; parameter type: e.g. template, query, etc.; data + type: string, etc.; required?; description. + + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + Lists information about all API + versions. + + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + + Creates a 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. + + + Database instances are directly + accessible only on the internal ServiceNet + network and using a Cloud resource within + the same regional datacenter. For example, + a database instance in DFW can only be + accessed by a Cloud Server in DFW. + + + + + + An instance + object. + + + Reference (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. + Rather than the flavor URI, you can also + pass the flavor id (integer) as the value for + flavorRef. For example, the flavor id for the + flavor URI shown above is + "1". + + + The volume size in gigabytes + (GB). The value specified must be between 1 + and 50. + + + A databases + object. + + + Name of the instance to + create. The length of the name is limited to + 255 characters and any characters are + permitted. + + + Specifies database names for + creating databases on instance + creation. + + + Set of symbols and encodings. + The default character set is + utf8. + + + Set of rules for comparing + characters in a character set. The default + value for collate is + utf8_general_ci. + + + A users + object. + + + The user name for the database + on instance creation. + + + The password for those users + on instance creation. + + + + + + + + + + + + + + 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 a specified database + instance, including any associated data. + This operation does not delete any read + slaves.Reviewer: please + provide a description of read slaves that I can add to + the previous note.This operation + is not allowed when the instance state is either + REBUILDING or + BUILDING. + + + + + + + + + &commonFaults; + + + + + + &getFaults; + + Lists information, including status, + for all database instances.This operation + lists the status and information for all database + instances. + + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + Shows database instance + details.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. + 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. + + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + + Restarts the database service on an + instance.The restart operation will + restart only the MySQL Instance. Restarting MySQL will + erase any dynamic configuration settings that you have + made within MySQL.The MySQL service + will be unavailable until the instance + restarts.This operation + returns a 202 Accepted response. + + + + + + + + + + + + + + + + &commonFaults; &getFaults; &postPutFaults; + + Resizes the memory for an + instance.This operation changes the + memory size of the instance, assuming a valid + flavorRef is provided. Restarts MySQL in the + process. + + + + + + + + + + + + + + + + &commonFaults; &getFaults; &postPutFaults; + + Resizes the volume attached to an + 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. + + + + + + + + + + + + + + + + &commonFaults; &getFaults; &postPutFaults; + + + Creates a database within a 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. See 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.See 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
Forwardslashes
+ + + + + + + + + + + + +
Length Restrictions for Database + Name
RestrictionValue
Database-name maximum length64
+ + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + Lists databases for a 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. + + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + Deletes a specified + database.This operation deletes the + requested database within the specified database + instance. Note that all data associated with the + database is also deleted. + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + + Creates a user for a 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. See 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. + + + See 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
Forwardslashes
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)
+ + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + Lists the users in a 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, See: http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html + + + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + Deletes a specified user for a + specified database instance.This + operation deletes the specified user for the specified + database instance. + There is a bug in a python library that + Rackspace 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. + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + + Enables the root user for a 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. + + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + + Shows root-enabled status for a + database instance. + Returns true if root user is enabled for a 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. + + + + + + + + + + + + + + + + &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. + Reviewer: please check that the xml example below + is now correct. Previously it was reported to be + incorrect. + + + + + + + + + + + + + + + + &commonFaults; &getFaults; + + Shows flavor details. + 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. + Writer: need to confirm that this behavior is not + changed in subsequent releases, and if it is + prevented, remove the Note above. + + + + + + + + + + + + + + + + &commonFaults; &getFaults; + diff --git a/api-ref/src/wadls/databases-api/xsd/dbaas.xsd b/api-ref/src/wadls/databases-api/xsd/dbaas.xsd new file mode 100644 index 000000000..e1ec29f15 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/dbaas.xsd @@ -0,0 +1,575 @@ + + + + + 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/api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-request-json-http.txt new file mode 100644 index 000000000..86b449b52 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-request-json-http.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/root HTTP/1.1 +User-Agent: python-example-client +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/api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-response-json-http.txt new file mode 100644 index 000000000..a7b5e387b --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 21 +Date: Wed, 25 Jan 2012 21:58:13 GMT \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-response.json b/api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-response.json new file mode 100644 index 000000000..39bed1f61 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-check-root-user-response.json @@ -0,0 +1,3 @@ +{ + "rootEnabled":true +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-request-json-http.txt new file mode 100644 index 000000000..a033c19c1 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-request-json-http.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/databases HTTP/1.1 +User-Agent: python-example-client +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/api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-request.json b/api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-request.json new file mode 100644 index 000000000..a3e2ea8c6 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-request.json @@ -0,0 +1,12 @@ +{ + "databases":[ + { + "character_set":"utf8", + "collate":"utf8_general_ci", + "name":"testingdb" + }, + { + "name":"sampledb" + } + ] +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-response-json-http.txt new file mode 100644 index 000000000..6a83f7fcb --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-create-databases-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:11:18 GMT diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-request-json-http.txt new file mode 100644 index 000000000..13446afd2 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-request-json-http.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: d6cafa5b-e0c7-4ab8-948e-7c95f2acd031 +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-request.json b/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-request.json new file mode 100644 index 000000000..9e38262be --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-request.json @@ -0,0 +1,30 @@ +{ + "instance":{ + "databases":[ + { + "character_set":"utf8", + "collate":"utf8_general_ci", + "name":"sampledb" + }, + { + "name":"nextround" + } + ], + "flavorRef":"https://openstack.example.com/v1.0/1234/flavors/1", + "name":"json_rack_instance", + "users":[ + { + "databases":[ + { + "name":"sampledb" + } + ], + "name":"demouser", + "password":"demopassword" + } + ], + "volume":{ + "size":2 + } + } +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-response-json-http.txt new file mode 100644 index 000000000..5ea2b4158 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 636 +Date: Wed, 25 Jan 2012 21:53:10 GMT \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-response.json b/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-response.json new file mode 100644 index 000000000..903d494f9 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-create-instance-response.json @@ -0,0 +1,36 @@ +{ + "instance":{ + "created":"2012-01-25T21:53:09Z", + "flavor":{ + "id":"1", + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://openstack.example.com/flavors/1", + "rel":"bookmark" + } + ] + }, + "hostname":"e09ad9a3f73309469cf1f43d11e79549caf9acf2.rackspaceclouddb.com", + "id":"dea5a2f7-3ec7-4496-adab-0abb5a42d635", + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/instances/dea5a2f7-3ec7-4496-adab-0abb5a42d635", + "rel":"self" + }, + { + "href":"https://openstack.example.com/instances/dea5a2f7-3ec7-4496-adab-0abb5a42d635", + "rel":"bookmark" + } + ], + "name":"json_rack_instance", + "status":"BUILD", + "updated":"2012-01-25T21:53:10Z", + "volume":{ + "size":2 + } + } +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-create-users-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-create-users-request-json-http.txt new file mode 100644 index 000000000..9ac79667d --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-create-users-request-json-http.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/1c59bdb8-03b6-4079-a7db-ba92d23a98b3/users HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: bb64d788-2dec-4a6b-a670-7151d108cacf +Accept: application/json +Content-Type: application/json \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-create-users-request.json b/api-ref/src/wadls/databases-api/xsd/samples/db-create-users-request.json new file mode 100644 index 000000000..10d90c95d --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-create-users-request.json @@ -0,0 +1,25 @@ +{ + "users":[ + { + "databases":[ + { + "name":"databaseA" + } + ], + "name":"dbuser3", + "password":"password" + }, + { + "databases":[ + { + "name":"databaseB" + }, + { + "name":"databaseC" + } + ], + "name":"dbuser4", + "password":"password" + } + ] +} diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-create-users-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-create-users-response-json-http.txt new file mode 100644 index 000000000..6a83f7fcb --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-create-users-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:11:18 GMT diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-delete-databases-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-databases-request-json-http.txt new file mode 100644 index 000000000..4140eae49 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-databases-request-json-http.txt @@ -0,0 +1,8 @@ +DELETE /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/databases/exampledb HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + + diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-delete-databases-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-databases-response-json-http.txt new file mode 100644 index 000000000..6a83f7fcb --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-databases-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:11:18 GMT diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-delete-instance-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-instance-request-json-http.txt new file mode 100644 index 000000000..f5bcbb793 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-instance-request-json-http.txt @@ -0,0 +1,6 @@ +DELETE /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f HTTP/1.1 +User-Agent: python-example-client +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/api-ref/src/wadls/databases-api/xsd/samples/db-delete-instance-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-instance-response-json-http.txt new file mode 100644 index 000000000..456166082 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-instance-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:15:51 GMT \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-delete-users-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-users-request-json-http.txt new file mode 100644 index 000000000..ed0f185b8 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-users-request-json-http.txt @@ -0,0 +1,8 @@ +DELETE /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/testuser HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + + diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-delete-users-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-users-response-json-http.txt new file mode 100644 index 000000000..e5f311463 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-delete-users-response-json-http.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 diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-request-json-http.txt new file mode 100644 index 000000000..7f081b6b1 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-request-json-http.txt @@ -0,0 +1,8 @@ +POST /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/root HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + + diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-response-json-http.txt new file mode 100644 index 000000000..ef590b61c --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 78 +Date: Wed, 25 Jan 2012 21:58:11 GMT \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-response.json b/api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-response.json new file mode 100644 index 000000000..13f0322b9 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-enable-root-user-response.json @@ -0,0 +1,6 @@ +{ + "user":{ + "name":"root", + "password":"d4311cb1-d912-45be-8517-e8a46f54df66" + } +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-request-json-http.txt new file mode 100644 index 000000000..972cb3c47 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-request-json-http.txt @@ -0,0 +1,8 @@ +GET /v1.0/1234/flavors/1 HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + + diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-response-json-http.txt new file mode 100644 index 000000000..409cdbfa2 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 209 +Date: Wed, 25 Jan 2012 21:53:05 GMT \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-response.json b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-response.json new file mode 100644 index 000000000..e39404a8d --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-by-id-response.json @@ -0,0 +1,17 @@ +{ + "flavor":{ + "id":1, + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://openstack.example.com/flavors/1", + "rel":"bookmark" + } + ], + "name":"m1.tiny", + "ram":512 + } +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-request-json-http.txt new file mode 100644 index 000000000..2c0f90975 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-request-json-http.txt @@ -0,0 +1,8 @@ +GET /v1.0/1234/flavors HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + + diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-response-json-http.txt new file mode 100644 index 000000000..0a4f0fe0b --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1768 +Date: Tue, 19 Jun 2012 19:52:45 GMT \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-response.json b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-response.json new file mode 100644 index 000000000..e4f96c4b2 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-flavors-response.json @@ -0,0 +1,64 @@ +{ + "flavors":[ + { + "id":1, + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://openstack.example.com/flavors/1", + "rel":"bookmark" + } + ], + "name":"m1.tiny", + "ram":512 + }, + { + "id":2, + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/flavors/2", + "rel":"self" + }, + { + "href":"https://openstack.example.com/flavors/2", + "rel":"bookmark" + } + ], + "name":"m1.small", + "ram":1024 + }, + { + "id":3, + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/flavors/3", + "rel":"self" + }, + { + "href":"https://openstack.example.com/flavors/3", + "rel":"bookmark" + } + ], + "name":"m1.medium", + "ram":2048 + }, + { + "id":4, + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/flavors/4", + "rel":"self" + }, + { + "href":"https://openstack.example.com/flavors/4", + "rel":"bookmark" + } + ], + "name":"m1.large", + "ram":4096 + } + ] +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-flavor-request.json b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-flavor-request.json new file mode 100644 index 000000000..6b02ece50 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-flavor-request.json @@ -0,0 +1,5 @@ +{ + "resize":{ + "flavorRef":"https://openstack.example.com/v1.0/1234/flavors/3" + } +} diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-flavor-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-flavor-response-json-http.txt new file mode 100644 index 000000000..fe14f4dd4 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-flavor-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:14:20 GMT diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-request-json-http.txt new file mode 100644 index 000000000..252ec5545 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-request-json-http.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: openstack.example.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/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-request.json b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-request.json new file mode 100644 index 000000000..9cafcedb0 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-request.json @@ -0,0 +1,5 @@ +{ + "resize":{ + "flavorRef":"https://openstack.example.com/v1.0/1234/flavors/2" + } +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-response-json-http.txt new file mode 100644 index 000000000..48a2e91a0 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-instance-response-json-http.txt @@ -0,0 +1,6 @@ +HTTP/1.1 202 Accepted +Content-Type: text/plain; charset=UTF-8 +Content-Length: 58 +Date: Mon, 06 Feb 2012 21:28:10 GMT + + diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-request-json-http.txt new file mode 100644 index 000000000..252ec5545 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-request-json-http.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: openstack.example.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/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-request.json b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-request.json new file mode 100644 index 000000000..de6c2c06a --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-request.json @@ -0,0 +1,7 @@ +{ + "resize":{ + "volume":{ + "size":4 + } + } +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-response-json-http.txt new file mode 100644 index 000000000..319bbadbb --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-resize-volume-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Content-Length: 0 +Date: Wed, 27 Jun 2012 23:12:20 GMT diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-request-json-http.txt new file mode 100644 index 000000000..cf3652d10 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-request-json-http.txt @@ -0,0 +1,6 @@ +POST /v1.0/1234/instances/13d940c4-70bb-4ff4-8866-6ee9ab5e5cae/action HTTP/1.1 +User-Agent: python-example-client +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/api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-request.json b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-request.json new file mode 100644 index 000000000..b378a6d32 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-request.json @@ -0,0 +1,5 @@ +{ + "restart":{ + + } +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-response-json-http.txt new file mode 100644 index 000000000..e5f311463 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-restart-response-json-http.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 diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-request-json-http.txt new file mode 100644 index 000000000..5ac19998c --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-request-json-http.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f HTTP/1.1 +User-Agent: python-example-client +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/api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-response-json-http.txt new file mode 100644 index 000000000..8a72a3a46 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 685 +Date: Wed, 28 Mar 2012 21:37:29 GMT \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-response.json b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-response.json new file mode 100644 index 000000000..4420c6248 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instance-status-detail-response.json @@ -0,0 +1,37 @@ +{ + "instance":{ + "created":"2012-03-28T21:31:02Z", + "flavor":{ + "id":"1", + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://openstack.example.com/flavors/1", + "rel":"bookmark" + } + ] + }, + "hostname":"e09ad9a3f73309469cf1f43d11e79549caf9acf2.rackspaceclouddb.com", + "id":"2450c73f-7805-4afe-a42c-4094ab42666b", + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/instances/2450c73f-7805-4afe-a42c-4094ab42666b", + "rel":"self" + }, + { + "href":"https://openstack.example.com/instances/2450c73f-7805-4afe-a42c-4094ab42666b", + "rel":"bookmark" + } + ], + "name":"xml_rack_instance", + "status":"ACTIVE", + "updated":"2012-03-28T21:34:25Z", + "volume":{ + "size":2, + "used":0.124542236328125 + } + } +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-request-json-http.txt new file mode 100644 index 000000000..820debcf1 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-request-json-http.txt @@ -0,0 +1,6 @@ +GET /v1.0/1234/instances HTTP/1.1 +User-Agent: python-example-client +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/api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-response-json-http.txt new file mode 100644 index 000000000..52d15a89f --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1150 +Date: Tue, 19 Jun 2012 19:53:04 GMT \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-response.json b/api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-response.json new file mode 100644 index 000000000..c716ed260 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-instances-index-response.json @@ -0,0 +1,66 @@ +{ + "instances":[ + { + "flavor":{ + "id":"1", + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://openstack.example.com/flavors/1", + "rel":"bookmark" + } + ] + }, + "id":"28d1b8f3-172a-4f6d-983d-36021508444a", + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/instances/28d1b8f3-172a-4f6d-983d-36021508444a", + "rel":"self" + }, + { + "href":"https://openstack.example.com/instances/28d1b8f3-172a-4f6d-983d-36021508444a", + "rel":"bookmark" + } + ], + "name":"json_rack_instance", + "status":"ACTIVE", + "volume":{ + "size":2 + } + }, + { + "flavor":{ + "id":"1", + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/flavors/1", + "rel":"self" + }, + { + "href":"https://openstack.example.com/flavors/1", + "rel":"bookmark" + } + ] + }, + "id":"8fb081af-f237-44f5-80cc-b46be1840ca9", + "links":[ + { + "href":"https://openstack.example.com/v1.0/1234/instances/8fb081af-f237-44f5-80cc-b46be1840ca9", + "rel":"self" + }, + { + "href":"https://openstack.example.com/instances/8fb081af-f237-44f5-80cc-b46be1840ca9", + "rel":"bookmark" + } + ], + "name":"xml_rack_instance", + "status":"ACTIVE", + "volume":{ + "size":2 + } + } + ] +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-request-json-http.txt new file mode 100644 index 000000000..d8cf1e6fd --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-request-json-http.txt @@ -0,0 +1,8 @@ +GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/databases HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + + diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-response-json-http.txt new file mode 100644 index 000000000..776e18d42 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 136 +Date: Wed, 25 Jan 2012 21:58:01 GMT \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-response.json b/api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-response.json new file mode 100644 index 000000000..fdea7bc8d --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-list-databases-response.json @@ -0,0 +1,19 @@ +{ + "databases":[ + { + "name":"anotherexampledb" + }, + { + "name":"exampledb" + }, + { + "name":"nextround" + }, + { + "name":"sampledb" + }, + { + "name":"testingdb" + } + ] +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-list-users-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-list-users-request-json-http.txt new file mode 100644 index 000000000..62ccf5166 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-list-users-request-json-http.txt @@ -0,0 +1,8 @@ +GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users HTTP/1.1 +User-Agent: python-example-client +Host: openstack.example.com +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + + diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-list-users-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-list-users-response-json-http.txt new file mode 100644 index 000000000..f4d95ac12 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-list-users-response-json-http.txt @@ -0,0 +1,4 @@ +HTTP/1.1 200 OK +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/api-ref/src/wadls/databases-api/xsd/samples/db-list-users-response.json b/api-ref/src/wadls/databases-api/xsd/samples/db-list-users-response.json new file mode 100644 index 000000000..716b63d3c --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-list-users-response.json @@ -0,0 +1,23 @@ +{ + "users":[ + { + "databases":[ + { + "name":"databaseA" + } + ], + "name":"dbuser3" + }, + { + "databases":[ + { + "name":"databaseB" + }, + { + "name":"databaseC" + } + ], + "name":"dbuser4" + } + ] +} \ No newline at end of file diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-version-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-version-request-json-http.txt new file mode 100644 index 000000000..9b7a3f54c --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-version-request-json-http.txt @@ -0,0 +1,6 @@ +GET /v1.0/ HTTP/1.1 +User-Agent: python-example-client +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/api-ref/src/wadls/databases-api/xsd/samples/db-version-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-version-response-json-http.txt new file mode 100644 index 000000000..61dfc6a32 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-version-response-json-http.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/api-ref/src/wadls/databases-api/xsd/samples/db-version-response.json b/api-ref/src/wadls/databases-api/xsd/samples/db-version-response.json new file mode 100644 index 000000000..06884653a --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-version-response.json @@ -0,0 +1,13 @@ +{ + "version":{ + "id":"v1.0", + "links":[ + { + "href":"https://openstack.example.com/v1.0/", + "rel":"self" + } + ], + "status":"CURRENT", + "updated":"2012-01-01T00:00:00Z" + } +} diff --git a/api-ref/src/wadls/databases-api/xsd/samples/db-versions-request-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-versions-request-json-http.txt new file mode 100644 index 000000000..5a1eee968 --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-versions-request-json-http.txt @@ -0,0 +1,6 @@ +GET / HTTP/1.1 +User-Agent: python-example-client +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/api-ref/src/wadls/databases-api/xsd/samples/db-versions-response-json-http.txt b/api-ref/src/wadls/databases-api/xsd/samples/db-versions-response-json-http.txt new file mode 100644 index 000000000..314c6835f --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-versions-response-json-http.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/api-ref/src/wadls/databases-api/xsd/samples/db-versions-response.json b/api-ref/src/wadls/databases-api/xsd/samples/db-versions-response.json new file mode 100644 index 000000000..6f71c465a --- /dev/null +++ b/api-ref/src/wadls/databases-api/xsd/samples/db-versions-response.json @@ -0,0 +1,15 @@ +{ + "versions":[ + { + "id":"v1.0", + "links":[ + { + "href":"https://openstack.example.com/v1.0/", + "rel":"self" + } + ], + "status":"CURRENT", + "updated":"2012-01-01T00:00:00Z" + } + ] +} diff --git a/pom.xml b/pom.xml index a8d7cf88a..0055ea28f 100644 --- a/pom.xml +++ b/pom.xml @@ -2,12 +2,10 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> 4.0.0 - org.openstack.docs parent-pom 1.0.0-SNAPSHOT pom - api-quick-start api-guide