From ca5236ca39842576ae3d8c74f82dc86b54cf42cb Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 13 Jan 2014 22:16:06 +0100 Subject: [PATCH] Fix whitespace Fix whitespace as noticed by checkniceness check. Change-Id: Ib09bff7ac6e3c74d1cecc7be470fcb72e1ee8641 --- apidocs/includewars.xml | 4 +- apidocs/src/resources/cdb-devguide.xml | 118 +++++++++--------- apidocs/src/resources/samples/db-auth-20.xml | 6 +- .../resources/samples/db-credentials-20.xml | 10 +- ...b-gs-create-database-instance-response.xml | 1 - .../db-instance-resize-instance-request.xml | 3 +- .../resources/samples/db-version-response.xml | 6 +- xsd/dbaas.wadl | 98 +++++++-------- xsd/dbaas.xsd | 14 +-- 9 files changed, 129 insertions(+), 131 deletions(-) diff --git a/apidocs/includewars.xml b/apidocs/includewars.xml index 7cedda0..bf2393a 100644 --- a/apidocs/includewars.xml +++ b/apidocs/includewars.xml @@ -8,8 +8,8 @@ ${project.basedir}/target/docbkx/webhelp - **.war + **.war - \ No newline at end of file + diff --git a/apidocs/src/resources/cdb-devguide.xml b/apidocs/src/resources/cdb-devguide.xml index 43e45ad..b62faee 100644 --- a/apidocs/src/resources/cdb-devguide.xml +++ b/apidocs/src/resources/cdb-devguide.xml @@ -10,7 +10,7 @@ PUT'> POST'> DELETE'> - + @@ -36,10 +36,10 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg" xmlns:m="http://www.w3.org/1998/Math/MathML" - xmlns:html="http://www.w3.org/1999/xhtml" + xmlns:html="http://www.w3.org/1999/xhtml" xml:id="cdb-devguide" version="5.0"> - + OpenStack Cloud Databases Developer Guide OpenStack Cloud Databases Developer @@ -73,9 +73,9 @@ This document is intended for software developers interested in developing applications using the OpenStack Cloud Databases Application Programming - Interface (API). + Interface (API). - + 2013-05-02 @@ -87,9 +87,9 @@ - + - + this is a placeholder for the front cover @@ -100,7 +100,7 @@ API Developer Guide cdb 20 - + Overview @@ -134,11 +134,11 @@
Intended Audience - This Guide is intended to assist software + 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: + with: ReSTful web services @@ -165,23 +165,23 @@ You can download the most current versions of this and other API-related documents from http://docs.openstack.org/. + >http://docs.openstack.org/. We welcome feedback, comments, and bug reports at https://bugs.launchpad.net/reddwarf. + >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. + >http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.
- + Concepts - To use the Cloud Databases API effectively, you should - understand several key 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 @@ -224,18 +224,18 @@ General API Information - The Cloud Databases API is implemented using a ReSTful + 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. + products and services. - All requests to authenticate against and operate the service are performed using - SSL over HTTP (HTTPS) on TCP port 443. + 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 + 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 @@ -250,16 +250,16 @@
Cloud Databases Service Versions - The Cloud Databases version defines the contract - and build information for the API. + The Cloud Databases version defines the contract + and build information for the API.
Contract Version - The contract version denotes the data model and + 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. + to be compatible with one another. Example Request URL (contract version @@ -271,7 +271,7 @@ <para>This document pertains to contract version 1.0.</para> </note> - + </section> <section xml:id="API_Version_Headers-d1e855"> <title>API Version @@ -284,9 +284,9 @@
Date/Time Format - The Database Service uses an ISO-8601 compliant + The Database Service uses an ISO-8601 compliant date format for the display and consumption of - date/time values. + 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. @@ -347,7 +347,7 @@ - +
Pagination @@ -359,7 +359,7 @@ 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 + 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 @@ -372,9 +372,9 @@ request the next 10 instances after the instance "1234" as follows: ?limit=10&marker=1234. Items are - displayed sorted by ID. + displayed sorted by ID. Pagination applies only to the calls listed in the - following table: + following table: @@ -394,13 +394,13 @@ &GET; - /instances/{instanceId}/databases + /instances/{instanceId}/databases Lists databases for the specified instance. &GET; - /instances/{instanceId}/users + /instances/{instanceId}/users Lists the users in the specified database instance. @@ -460,11 +460,11 @@
Faults - When an error occurs, the Database Service returns + 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. + information about the fault. The following table lists possible fault types with their associated error codes and descriptions. @@ -548,7 +548,7 @@ The following two instanceFault examples show errors when the server has erred or cannot perform the requested operation: - + Example instanceFault Response: XML @@ -563,7 +563,7 @@ - The error code (code) is returned in the body of the response for + 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 @@ -571,7 +571,7 @@ 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. + on the type of error. The following two badRequest examples show errors when the volume size is invalid: @@ -590,7 +590,7 @@ - The next two examples show + The next two examples show itemNotFound errors: Example itemNotFound Fault: XML @@ -706,7 +706,7 @@ ACTIVE – The database instance is - online and available to take requests. + online and available to take requests. BLOCKED – The database instance is @@ -720,7 +720,7 @@ 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. + is shut down but not the actual server. If MySQL has crashed (causing the @@ -732,13 +732,13 @@ ERROR – The last operation for the database instance failed due to an - error. - + error. +
- - API Operations @@ -762,9 +762,9 @@ - +
- +
Database Instances This section describes the operations that are supported for database instances. @@ -776,13 +776,13 @@ - + - +
@@ -811,8 +811,8 @@ -
- +
+
Users This section describes the operations that are @@ -823,7 +823,7 @@ 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. + instance. There is a bug in a python library that development is using that may cause incorrect user @@ -860,7 +860,7 @@
- +
Flavors This section describes the operations that are @@ -901,11 +901,11 @@ 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 + 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/resources/samples/db-auth-20.xml b/apidocs/src/resources/samples/db-auth-20.xml index 0dd1969..597eb16 100644 --- a/apidocs/src/resources/samples/db-auth-20.xml +++ b/apidocs/src/resources/samples/db-auth-20.xml @@ -61,14 +61,14 @@ Date: Thu, 12 Apr 2012 18:50:20 GMT + publicURL="https://cdn1.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"/> + publicURL="https://cdn2.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"/> - \ No newline at end of file + diff --git a/apidocs/src/resources/samples/db-credentials-20.xml b/apidocs/src/resources/samples/db-credentials-20.xml index cd3298b..0ab471f 100644 --- a/apidocs/src/resources/samples/db-credentials-20.xml +++ b/apidocs/src/resources/samples/db-credentials-20.xml @@ -6,9 +6,9 @@ Content-Type: application/xml Content-Length: 88 - - + + diff --git a/apidocs/src/resources/samples/db-gs-create-database-instance-response.xml b/apidocs/src/resources/samples/db-gs-create-database-instance-response.xml index 967a5dd..ea53c56 100644 --- a/apidocs/src/resources/samples/db-gs-create-database-instance-response.xml +++ b/apidocs/src/resources/samples/db-gs-create-database-instance-response.xml @@ -19,4 +19,3 @@ Date: Thu, 05 Apr 2012 16:17:29 GMT - diff --git a/apidocs/src/resources/samples/db-instance-resize-instance-request.xml b/apidocs/src/resources/samples/db-instance-resize-instance-request.xml index fd51dc8..2488717 100644 --- a/apidocs/src/resources/samples/db-instance-resize-instance-request.xml +++ b/apidocs/src/resources/samples/db-instance-resize-instance-request.xml @@ -7,6 +7,5 @@ Content-Type: application/xml - https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2 + https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2 - diff --git a/apidocs/src/resources/samples/db-version-response.xml b/apidocs/src/resources/samples/db-version-response.xml index d978f23..47a29a2 100644 --- a/apidocs/src/resources/samples/db-version-response.xml +++ b/apidocs/src/resources/samples/db-version-response.xml @@ -4,7 +4,7 @@ Content-Length: 218 Date: Wed, 25 Jan 2012 21:53:04 GMT - - - + + + diff --git a/xsd/dbaas.wadl b/xsd/dbaas.wadl index 1966f81..023060f 100644 --- a/xsd/dbaas.wadl +++ b/xsd/dbaas.wadl @@ -31,7 +31,7 @@ - + @@ -72,7 +72,7 @@ The name for the specified database. - + @@ -83,7 +83,7 @@ - + The flavor ID for the specified flavor. @@ -100,7 +100,7 @@ Returns detailed information about the specified version of the API. - + This operation returns detailed information about the specified version of the API. @@ -192,8 +192,8 @@ Required and Optional Attributes for Create Instance - Applies To - Name + Applies To + Name Description Required @@ -202,7 +202,7 @@ 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. 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. @@ -338,7 +338,7 @@ The following examples show the List All Database Instances Detail requests: - + @@ -352,7 +352,7 @@ The following examples show the List All Database Instances responses: - + @@ -374,7 +374,7 @@ 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 + 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. @@ -390,7 +390,7 @@ - + Required and Optional Attributes for Create Database - Name + Name Description Required @@ -568,7 +568,7 @@ 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. @@ -673,7 +673,7 @@ - + &commonFaults; &getFaults; @@ -684,7 +684,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, + 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. @@ -699,7 +699,7 @@ - + The following examples show the paginated List Databases for Instance requests: @@ -726,7 +726,7 @@ - + @@ -789,14 +789,14 @@ 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: - + - + - + @@ -822,7 +822,7 @@
Required Attributes for Create User
Applies ToName Name Description Required
- + Notes A user is granted all privileges on the specified databases. @@ -953,8 +953,8 @@ 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). + 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: @@ -984,7 +984,7 @@ - + The following examples show the paginated List Users in Database Instance requests: @@ -1012,7 +1012,7 @@ - + @@ -1026,7 +1026,7 @@ - + &commonFaults; &getFaults; @@ -1035,9 +1035,9 @@ 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. + This operation changes the MySQL password of one or more users. + For information about choosing a valid password, please refer to + for details. @@ -1077,10 +1077,10 @@ 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 + 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. @@ -1112,7 +1112,7 @@ &commonFaults; &getFaults; - + Lists the specified user's name and a list of databases that the user can access. @@ -1147,12 +1147,12 @@ &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. - + @@ -1183,14 +1183,14 @@ &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 + 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. - + @@ -1221,12 +1221,12 @@ &commonFaults; &getFaults; - + Remove access to the specified database for the specified user. This operation removes access to the specified database for the specified user. - + @@ -1263,10 +1263,10 @@ 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) + 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. @@ -1345,7 +1345,7 @@ 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. - + @@ -1380,14 +1380,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 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. diff --git a/xsd/dbaas.xsd b/xsd/dbaas.xsd index 2ef7467..06f05f6 100644 --- a/xsd/dbaas.xsd +++ b/xsd/dbaas.xsd @@ -1,11 +1,11 @@ - @@ -95,7 +95,7 @@ - + @@ -107,8 +107,8 @@ - - + + @@ -311,7 +311,7 @@ - + @@ -447,7 +447,7 @@ - +