diff --git a/xsd/dbaas.wadl b/xsd/dbaas.wadl index 02bb7416..91953198 100644 --- a/xsd/dbaas.wadl +++ b/xsd/dbaas.wadl @@ -31,7 +31,7 @@ - + @@ -71,7 +71,7 @@ - + The flavor ID for the specified flavor. @@ -176,9 +176,9 @@ 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. For details and information about using a public Cloud Load Balancer to allow access to your database instance, refer to - for details. + + 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. For details and information about using a public Cloud Load Balancer to allow access to your database instance, refer to + for details. The following table lists the required and optional attributes for Create Instance: @@ -196,10 +196,10 @@ Instance flavorRef - Reference (href) to a flavor as specified in the response from the List Flavors API call. + 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. For example, in the following List Flavors response, the link to flavor id 1 is specified as "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1". - 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". + 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". Refer to for details. Yes @@ -290,9 +290,9 @@ 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 does not delete any read slaves. + 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. + This operation is not allowed when the instance state is either REBUILDING or BUILDING. @@ -335,7 +335,7 @@ The following examples show the List All Database Instances Detail requests: - + @@ -349,7 +349,7 @@ The following examples show the List All Database Instances responses: - + @@ -369,10 +369,10 @@ 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 + 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, or RESIZE. + 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, or RESIZE. 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. @@ -387,7 +387,7 @@ - + Restart the database service on the 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. + The MySQL service will be unavailable until the instance restarts. This operation returns a 202 Accepted response. @@ -490,7 +490,7 @@ 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. + You cannot increase the volume to a size larger than the API volume size limit specifies. This operation returns a 202 Accepted response. @@ -565,9 +565,9 @@ 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. + + 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. @@ -670,7 +670,7 @@ - + &commonFaults; &getFaults; @@ -681,7 +681,7 @@ 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. + 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. @@ -759,10 +759,10 @@ 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: - +
- + @@ -792,7 +792,7 @@
Required Attributes for Create User
Applies To
- + Notes A user is granted all privileges on the specified databases. @@ -924,7 +924,7 @@ 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. + 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: @@ -978,11 +978,11 @@ 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 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. + 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. @@ -1019,7 +1019,7 @@ 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. + 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. @@ -1132,14 +1132,14 @@ &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. + 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.