Fix whitespace
Fix whitespace as noticed by checkniceness check. Change-Id: Ib09bff7ac6e3c74d1cecc7be470fcb72e1ee8641
This commit is contained in:
Andreas Jaeger
parent
3d5bdb45ec
commit
ca5236ca39
@ -73,7 +73,7 @@
|
||||
<para>This document is intended for software developers
|
||||
interested in developing applications using the
|
||||
OpenStack Cloud Databases Application Programming
|
||||
Interface (<abbrev>API</abbrev>). </para>
|
||||
Interface (<abbrev>API</abbrev>).</para>
|
||||
</abstract>
|
||||
|
||||
<revhistory>
|
||||
@ -134,11 +134,11 @@
|
||||
<?hard-pagebreak?>
|
||||
<section xml:id="Intended_Audience-d1e122">
|
||||
<title>Intended Audience</title>
|
||||
<para> This Guide is intended to assist software
|
||||
<para>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: </para>
|
||||
with:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>ReSTful web services</para>
|
||||
@ -165,14 +165,14 @@
|
||||
<para>You can download the most current versions of this
|
||||
and other API-related documents from <link
|
||||
xlink:href="http://docs.openstack.org/"
|
||||
>http://docs.openstack.org/</link>. </para>
|
||||
>http://docs.openstack.org/</link>.</para>
|
||||
<para>We welcome feedback, comments, and bug reports at
|
||||
<link xlink:href="https://bugs.launchpad.net/reddwarf"
|
||||
>https://bugs.launchpad.net/reddwarf</link>. </para>
|
||||
>https://bugs.launchpad.net/reddwarf</link>.</para>
|
||||
<para>This API uses standard HTTP 1.1 response codes as
|
||||
documented at: <link
|
||||
xlink:href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
|
||||
>http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</link>. </para>
|
||||
>http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</link>.</para>
|
||||
</section>
|
||||
<?hard-pagebreak?>
|
||||
</chapter>
|
||||
@ -180,8 +180,8 @@
|
||||
<chapter xml:id="Concepts-d1e563">
|
||||
<title>Concepts</title>
|
||||
<?dbhtml stop-chunking?>
|
||||
<para> To use the Cloud Databases API effectively, you should
|
||||
understand several key concepts: </para>
|
||||
<para>To use the Cloud Databases API effectively, you should
|
||||
understand several key concepts:</para>
|
||||
<section xml:id="DatabaseInstance-d1e588">
|
||||
<title>Database Instance</title>
|
||||
<para>A database instance is an isolated MySQL instance in
|
||||
@ -224,18 +224,18 @@
|
||||
</chapter>
|
||||
<chapter xml:id="General_API_Information-d1e633">
|
||||
<title>General API Information</title>
|
||||
<para> The Cloud Databases API is implemented using a ReSTful
|
||||
<para>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. </para>
|
||||
products and services.</para>
|
||||
<note>
|
||||
<para> All requests to authenticate against and operate the service are performed using
|
||||
SSL over HTTP (HTTPS) on TCP port 443. </para>
|
||||
<para>All requests to authenticate against and operate the service are performed using
|
||||
SSL over HTTP (HTTPS) on TCP port 443.</para>
|
||||
</note>
|
||||
<section xml:id="Authentication-d1e647">
|
||||
<title>Authentication</title>
|
||||
<para> Each HTTP request against the Cloud Database
|
||||
<para>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,11 +250,11 @@
|
||||
</section>
|
||||
<section xml:id="DB_service_versions">
|
||||
<title>Cloud Databases Service Versions</title>
|
||||
<para> The Cloud Databases version defines the contract
|
||||
and build information for the API. </para>
|
||||
<para>The Cloud Databases version defines the contract
|
||||
and build information for the API.</para>
|
||||
<section xml:id="Contract_Version-d1e825">
|
||||
<title>Contract Version</title>
|
||||
<para> The contract version denotes the data model and
|
||||
<para>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
|
||||
@ -284,9 +284,9 @@
|
||||
<?hard-pagebreak?>
|
||||
<section xml:id="datetimeformat">
|
||||
<title>Date/Time Format</title>
|
||||
<para> The Database Service uses an ISO-8601 compliant
|
||||
<para>The Database Service uses an ISO-8601 compliant
|
||||
date format for the display and consumption of
|
||||
date/time values. </para>
|
||||
date/time values.</para>
|
||||
<para>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.
|
||||
@ -359,7 +359,7 @@
|
||||
20. If a request supplies no limit or one that exceeds
|
||||
the configured default limit, the default is used
|
||||
instead.</para>
|
||||
<para> Pagination provides the ability to limit the size
|
||||
<para>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. <emphasis>Limit</emphasis>
|
||||
@ -372,9 +372,9 @@
|
||||
request the next 10 instances after the instance
|
||||
"1234" as follows:
|
||||
<code>?limit=10&marker=1234</code>. Items are
|
||||
displayed sorted by ID. </para>
|
||||
displayed sorted by ID.</para>
|
||||
<para>Pagination applies only to the calls listed in the
|
||||
following table: </para>
|
||||
following table:</para>
|
||||
<informaltable rules="all">
|
||||
<thead>
|
||||
<tr align="center">
|
||||
@ -394,13 +394,13 @@
|
||||
<tr>
|
||||
<td colspan="1">&GET;</td>
|
||||
<td colspan="2">
|
||||
/instances/{instanceId}/databases </td>
|
||||
/instances/{instanceId}/databases</td>
|
||||
<td colspan="3">Lists databases for the
|
||||
specified instance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">&GET;</td>
|
||||
<td colspan="2"> /instances/{instanceId}/users </td>
|
||||
<td colspan="2"> /instances/{instanceId}/users</td>
|
||||
<td colspan="3">Lists the users in the
|
||||
specified database instance.</td>
|
||||
</tr>
|
||||
@ -460,11 +460,11 @@
|
||||
</section>
|
||||
<section xml:id="DB_faults">
|
||||
<title>Faults</title>
|
||||
<para> When an error occurs, the Database Service returns
|
||||
<para>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. </para>
|
||||
information about the fault.</para>
|
||||
<para>The following table lists possible fault types with their associated error codes
|
||||
and descriptions.</para>
|
||||
<informaltable rules="all">
|
||||
@ -563,7 +563,7 @@
|
||||
<xi:include href="samples/db-faults-instanceFault.json" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para> The error code (<code>code</code>) is returned in the body of the response for
|
||||
<para>The error code (<code>code</code>) is returned in the body of the response for
|
||||
convenience. The <code>message</code> element returns a human-readable message that
|
||||
is appropriate for display to the end user. The <code>details</code> 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.</para>
|
||||
<para>The fault's root element (for example,
|
||||
<code>instanceFault</code>) may change depending
|
||||
on the type of error. </para>
|
||||
on the type of error.</para>
|
||||
<para><?rax-fo keep-with-next?>The following two <code>badRequest</code> examples
|
||||
show errors when the volume size is invalid:</para>
|
||||
<example>
|
||||
@ -590,7 +590,7 @@
|
||||
<xi:include href="samples/db-faults-badRequest.json" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para> The next two examples show
|
||||
<para>The next two examples show
|
||||
<code>itemNotFound</code> errors:</para>
|
||||
<example>
|
||||
<title>Example itemNotFound Fault: XML</title>
|
||||
@ -720,7 +720,7 @@
|
||||
<para>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. </para>
|
||||
is shut down but not the actual server.</para>
|
||||
<para>
|
||||
<note>
|
||||
<para>If MySQL has crashed (causing the
|
||||
@ -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. </para>
|
||||
instance.</para>
|
||||
<warning>
|
||||
<para>There is a bug in a python library that
|
||||
development is using that may cause incorrect user
|
||||
|
||||
@ -19,4 +19,3 @@ Date: Thu, 05 Apr 2012 16:17:29 GMT
|
||||
</links>
|
||||
</flavor>
|
||||
</instance>
|
||||
|
||||
|
||||
@ -9,4 +9,3 @@ Content-Type: application/xml
|
||||
<resize xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<flavorRef>https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2</flavorRef>
|
||||
</resize>
|
||||
|
||||
|
||||
@ -192,8 +192,8 @@
|
||||
<caption>Required and Optional Attributes for Create Instance</caption>
|
||||
<thead>
|
||||
<tr>
|
||||
<td colspan="1">Applies To </td>
|
||||
<td colspan="1">Name </td>
|
||||
<td colspan="1">Applies To</td>
|
||||
<td colspan="1">Name</td>
|
||||
<td colspan="3">Description</td>
|
||||
<td colspan="1">Required</td>
|
||||
</tr>
|
||||
@ -541,7 +541,7 @@
|
||||
<caption>Required and Optional Attributes for Create Database</caption>
|
||||
<thead>
|
||||
<tr>
|
||||
<td colspan="1">Name </td>
|
||||
<td colspan="1">Name</td>
|
||||
<td colspan="3">Description</td>
|
||||
<td colspan="1">Required</td>
|
||||
</tr>
|
||||
@ -796,7 +796,7 @@
|
||||
<thead>
|
||||
<tr>
|
||||
<td colspan="1">Applies To</td>
|
||||
<td colspan="1">Name </td>
|
||||
<td colspan="1">Name</td>
|
||||
<td colspan="2">Description</td>
|
||||
<td colspan="1">Required</td>
|
||||
</tr>
|
||||
@ -953,7 +953,7 @@
|
||||
<method name="GET" id="getUsers">
|
||||
<wadl:doc xml:lang="EN" title="List Users in Database Instance" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists the users in the specified database instance.</para>
|
||||
<para>This operation lists the users in the specified database instance, along with the associated databases for that user. </para>
|
||||
<para>This operation lists the users in the specified database instance, along with the associated databases for that user.</para>
|
||||
<note><para>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.</para></note>
|
||||
|
||||
@ -1035,7 +1035,7 @@
|
||||
<method name="PUT" id="changePass">
|
||||
<wadl:doc xml:lang="EN" title="Change User(s) Password" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Changes the MySQL password of one or more users.</para>
|
||||
<para>This operation changes the MySQL password of one or more users. </para>
|
||||
<para>This operation changes the MySQL password of one or more users.</para>
|
||||
<note><para>For information about choosing a valid password, please refer to
|
||||
<xref linkend="POST_createUser__version___accountId__instances__instanceId__users_"/> for details.</para></note>
|
||||
</wadl:doc>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user