Skip to content
Browse files

Merge pull request #432 from masthalter/docupdates_sp19a

completed first-pass doc updates for Sprint 19
  • Loading branch information...
2 parents 9a454d5 + e7c5b9c commit e6cdc7c11ce192f7acdf9ad3f22712fdc3a9a970 @hub-cap hub-cap committed Mar 27, 2012
View
25 apidocs/src/resources/cdb-devguide.xml
@@ -60,7 +60,7 @@
</copyright>
<releaseinfo>API v1.0 BETA</releaseinfo>
<productname>Rackspace Cloud Database</productname>
- <pubdate>2012-03-13</pubdate>
+ <pubdate>2012-04-04</pubdate>
<legalnotice role="rs-api">
<annotation>
<remark>Copyright details are filled in by the template.</remark>
@@ -75,6 +75,27 @@
<revhistory>
<revision>
+ <date>2012-04-04</date>
+ <revdescription>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Added volume capacity information to
+ List Database Instance Status and
+ Details response (see <xref
+ linkend="GET_getInstanceById__version___accountID__instances__instanceId__Database_Instances"
+ />).</para>
+ </listitem>
+ <listitem>
+ <para>Fixed examples and required
+ attributes for Create User to match
+ the latest API updates (see <xref
+ linkend="POST_createUser__version___accountID__instances__instanceId__users_user_management"
+ />).</para>
+ </listitem>
+ </itemizedlist>
+ </revdescription>
+ </revision>
+ <revision>
<date>2012-03-13</date>
<revdescription>
<itemizedlist spacing="compact">
@@ -1410,8 +1431,6 @@
</section>
<section xml:id="DB_faults">
<title>Faults</title>
- <remark>Reviewer: need to update this section as needed
- for Cloud Database.</remark>
<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
View
20 apidocs/src/resources/cdb-getting-started.xml
@@ -43,9 +43,20 @@
<holder>Rackspace US, Inc.</holder>
</copyright>
<releaseinfo>API v1.0 BETA</releaseinfo>
- <pubdate>2012-03-13</pubdate>
+ <pubdate>2012-03-xx</pubdate>
<revhistory>
<revision>
+ <date>2012-03-xx</date>
+ <revdescription>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Added trademark to Cloud
+ Servers.</para>
+ </listitem>
+ </itemizedlist>
+ </revdescription>
+ </revision>
+ <revision>
<date>2012-03-13</date>
<revdescription>
<itemizedlist spacing="compact">
@@ -203,9 +214,10 @@
<section xml:id="DB_Overview">
<title>Overview</title>
<para>Follow the steps described in this guide to use the
- Rackspace Cloud Database API and the Cloud Servers section
- of the Control Panel to create and access your database
- instances via Rackspace Cloud Servers.</para>
+ Rackspace Cloud Database API and the Cloud
+ Servers<trademark/> section of the Control Panel to create
+ and access your database instances via Rackspace Cloud
+ Servers.</para>
<para>For details about using the Cloud Database API, refer to
the <citetitle>Cloud Database Developer
Guide</citetitle>.</para>
View
52 apidocs/src/resources/cdb-mgmt-devguide.xml
@@ -56,7 +56,7 @@
</copyright>
<releaseinfo>API v1.0 BETA</releaseinfo>
<productname>Rackspace Cloud Database BETA</productname>
- <pubdate>2012-01-26</pubdate>
+ <pubdate>2012-04-04</pubdate>
<legalnotice role="rs-api">
<annotation>
<remark>Copyright details are filled in by the template.</remark>
@@ -72,6 +72,35 @@
<revhistory>
<revision>
+ <date>2012-04-04</date>
+ <revdescription>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Added new section <xref
+ linkend="Service_Access_Endpoints-d1e753"
+ />.</para>
+ </listitem>
+ <listitem>
+ <para>Added new section <xref
+ linkend="Host_Information"
+ />.</para>
+ </listitem>
+ <listitem>
+ <para>Added new section <xref
+ linkend="Management_Instances_Actions"
+ />.</para>
+ </listitem>
+ <listitem>
+ <para>Updated response examples for List
+ Database Instance Status and Details
+ (see <xref
+ linkend="Database_Instance_Management"
+ />).</para>
+ </listitem>
+ </itemizedlist>
+ </revdescription>
+ </revision>
+ <revision>
<date>2012-01-26</date>
<revdescription>
<itemizedlist spacing="compact">
@@ -329,6 +358,27 @@
appropriate LDAP roles/permissions added. </para>
</note>
</section>
+ <section xml:id="Service_Access_Endpoints-d1e753">
+ <title>Service Access</title>
+ <para>The Database Service is a regionalized service. The
+ user of the service is therefore responsible for
+ appropriate replication, caching, and overall
+ maintenance of Cloud Database data across regional
+ boundaries to other Cloud Database servers.</para>
+ <?rax-fo keep-with-next?>
+ <para>Replace the sample account ID number,
+ <parameter>1234</parameter>, as shown in the URLs
+ in this guide, with your actual account number
+ returned as part of the authentication service
+ response.</para>
+ <para>You will find the actual account number after the
+ final '/' in the <code>publicURL</code> field returned
+ by the authentication response. In the following
+ example, you can see from the <code>publicURL</code>
+ field for <code>cloudServers</code>
+ (publicURL="https://servers.api.rackspacecloud.com/v1.0/322781")
+ that the account number is 322781.</para>
+ </section>
<section xml:id="Request_Response_Types-d1e503">
<title>Request/Response Types</title>
<para> The Cloud Database API supports both the JSON and
View
46 xsd/dbaas.wadl
@@ -186,13 +186,15 @@
<caption>Required and Optional Attributes for Create Instance</caption>
<thead>
<tr>
+ <td colspan="1">Applies To </td>
<td colspan="1">Name </td>
<td colspan="3">Description</td>
<td colspan="1">Required</td>
</tr>
</thead>
<tbody>
<tr>
+ <td colspan="1" rowspan="3">Instance</td>
<td colspan="1">flavorRef</td>
<td colspan="3"><para>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
@@ -212,8 +214,9 @@
<td colspan="1">No</td>
</tr>
<tr>
- <td colspan="1">databases name, name, ...</td>
- <td colspan="3">Specifies database names (and additional attributes) for creating databases on instance creation. Refer to <xref linkend="POST_createDatabase__version___accountID__instances__instanceId__databases_databases"/> for the required xml/json format.</td>
+ <td colspan="1" rowspan="3">Database</td>
+ <td colspan="1">name</td>
+ <td colspan="3">Specifies database names for creating databases on instance creation. Refer to <xref linkend="POST_createDatabase__version___accountID__instances__instanceId__databases_databases"/> for the required xml/json format.</td>
<td colspan="1">No</td>
</tr>
<tr>
@@ -227,8 +230,19 @@
<td colspan="1">No</td>
</tr>
<tr>
- <td colspan="1">users</td>
- <td colspan="3">Specifies user name and password and associated databases for those users on instance creation. Refer to <xref linkend="POST_createUser__version___accountID__instances__instanceId__users_users"/> for the required xml/json format.</td>
+ <td colspan="1" rowspan="3">User</td>
+ <td colspan="1">name</td>
+ <td colspan="3">Specifies user name for the database on instance creation. Refer to <xref linkend="POST_createUser__version___accountID__instances__instanceId__users_user_management"/> for the required xml/json format.</td>
+ <td colspan="1">No</td>
+ </tr>
+ <tr>
+ <td colspan="1">password</td>
+ <td colspan="3">Specifies password for those users on instance creation. Refer to <xref linkend="POST_createUser__version___accountID__instances__instanceId__users_user_management"/> for the required xml/json format.</td>
+ <td colspan="1">No</td>
+ </tr>
+ <tr>
+ <td colspan="1">(database) name</td>
+ <td colspan="3">Specifies names of databases that those users can access on instance creation. Refer to Refer to <xref linkend="POST_createUser__version___accountID__instances__instanceId__users_user_management"/> for the required xml/json format.</td>
<td colspan="1">No</td>
</tr>
</tbody>
@@ -506,15 +520,16 @@
<method name="POST" id="resizeVolume">
<wadl:doc xml:lang="EN" title="Resize the Instance Volume" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Resize the volume attached to the Instance.</para>
- <para>This operation supports resizing the attached volume for an instance. It supports only increasing the volume size and does not support decreasing the size.</para>
+ <para>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.</para>
<note>You cannot increase the volume to a size larger than the API volume size limit specifies.</note>
<para>This operation returns a 202 Accepted response.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml"
element="dbaas:Resize">
<doc>
- <para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance requests:</para>
+ <para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance Volume requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-resize-volume-request.xml"/>
</doc>
</representation>
@@ -528,7 +543,7 @@
<response status="202">
<representation mediaType="application/xml">
<doc>
- <para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance responses:</para>
+ <para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance Volume responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-resize-volume-response.xml"/>
</doc>
</representation>
@@ -780,31 +795,30 @@
<thead>
<tr>
- <td colspan="2">Name </td>
+ <td colspan="1">Applies To</td>
+ <td colspan="1">Name </td>
<td colspan="2">Description</td>
<td colspan="1">Required</td>
</tr>
</thead>
<tbody>
<tr>
- <td colspan="2">name</td>
+ <td colspan="1" rowspan="3">User</td>
+ <td colspan="1">name</td>
<td colspan="2">Name of the user for the
database.</td>
<td colspan="1">Yes</td>
</tr>
<tr>
- <td colspan="2">password</td>
+ <td colspan="1">password</td>
<td colspan="2">User password for database
access.</td>
<td colspan="1">Yes</td>
</tr>
<tr>
- <td colspan="2" rowspan="2"><para>database</para> <para><emphasis role="bold">--or--</emphasis></para> <para>databases name, name, ...</para></td>
- <td colspan="2"><para>Name of the database that the user can access.</para></td>
- <td colspan="1" rowspan="2"><para>Yes</para></td>
- </tr>
- <tr>
- <td colspan="2"><para>Names of the databases that the user can access.</para></td>
+ <td colspan="1">(database) name</td>
+ <td colspan="2"><para>Name of the database that the user can access. One or more database names must be specified.</para></td>
+ <td colspan="1">No</td>
</tr>
</tbody>
</table>
View
15 xsd/management.wadl
@@ -288,15 +288,16 @@
<wadl:doc xml:lang="EN" title="Update the Guest Agent" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Update the guest agent on the instance.</para>
<para>This operation returns a 202 Accepted response.</para>
- <para>While the guest agent is being updated the instance status
- will be TODO_MYSTERY and some calls which require the agent
- (such as listing databases or users) will return
- unprocessableEntity (422).</para>
+ <para>In all cases, the call returns immediately. To determine if the operation succeeded,
+ call Get Diagnostics Info (see <xref linkend="GET_getdiagnosticdetails_mgmt_instances__instanceId__diagnostics_Database_Instance_Management"></xref>)
+ to check whether the version of the guest installed on the instance has changed. Note that the version will <emphasis>not</emphasis> change if no new version of the guest is available.
+ </para>
+ <para>In the event an upgrade fails and leaves the guest in a bad state, the instance status changes to "ERROR". At this point certain API functionality may not work on the instance, and manual intervention by support is necessary.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:UpdateGuest">
<doc>
- <para xmlns="http://docbook.org/ns/docbook">The following examples show the Update Guest Instance requests:</para>
+ <para xmlns="http://docbook.org/ns/docbook">The following examples show the Update Guest Agent requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-guest-update-request.xml"/>
</doc>
</representation>
@@ -309,7 +310,7 @@
<response status="202">
<representation mediaType="application/xml">
<doc>
- <para xmlns="http://docbook.org/ns/docbook">The following examples show the UpdateGuest Instance responses:</para>
+ <para xmlns="http://docbook.org/ns/docbook">The following examples show the UpdateGuest Agent responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-guest-update-response.xml"/>
</doc>
</representation>
@@ -654,7 +655,7 @@
</para>
<para>This operation provides the following info for the guest agent managing the specified instance.</para>
<table rules="all">
- <caption>Return attributes for Get Diagnostics Info</caption>
+ <caption>Return Attributes for Get Diagnostics Info</caption>
<thead>
<tr>
<td colspan="1">Name</td>

0 comments on commit e6cdc7c

Please sign in to comment.
Something went wrong with that request. Please try again.