Update Databases API to spellcheck and make other changes
- Remove passive voice from api-site - Renamed code samples using this naming convention: <resource>-<action>-request.json or <resource>-<action>-response.json. For example, volume-create-request.json and volume-create-response.json. - Removed unused code samples - Made method names consistent throughout - use list<resource> for list operations, show<resource> for show operations, and so on. - Change csapi:uuid -> csapi:UUID Change-Id: I3e2cbc3454beffd1ed67a377f85cf62bed118c94 Partial-Bug: #1521244
This commit is contained in:
Diane Fleming
@@ -10,43 +10,50 @@
|
||||
<title>Database Service API v1.0 (CURRENT)</title>
|
||||
<section xml:id="API_Versions">
|
||||
<title>API versions</title>
|
||||
<para>
|
||||
Lists information for all Database Service API versions and shows
|
||||
Database Service v1.0 details.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#dbaas-versions-v1">
|
||||
<wadl:method href="#getVersions"/>
|
||||
<wadl:method href="#listVersions-dbaas-v1"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#dbaas-version-v1">
|
||||
<wadl:method href="#getVersionInfo"/>
|
||||
<wadl:method href="#showVersionInfo-dbaas-v1"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- add back later - validation errors -->
|
||||
<section xml:id="Database_Instances">
|
||||
<title>Database instances (instances)</title>
|
||||
<para>
|
||||
Creates, lists, shows details for, attaches a configuration group
|
||||
to, detaches a configuration group from, deletes, lists
|
||||
configuration defaults, creates root, and determines whether root
|
||||
is enables for instances.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#instances">
|
||||
<wadl:resource href="../wadls/databases-api/xsd/dbaas.wadl#instances">
|
||||
<wadl:method href="#createInstance"/>
|
||||
<wadl:method href="#getInstance"/>
|
||||
<wadl:method href="#listInstances"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#instanceId">
|
||||
<wadl:method href="#getInstanceById"/>
|
||||
<wadl:method href="#deleteInstance"/>
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#instanceId">
|
||||
<wadl:method href="#showInstanceById"/>
|
||||
<wadl:method href="#attachConfigGroup"/>
|
||||
<wadl:method href="#detachConfigGroup"/>
|
||||
<wadl:method href="#deleteInstance"/>
|
||||
<wadl:method href="#listConfigDefaults"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#root">
|
||||
<wadl:method href="#createRoot"/>
|
||||
<wadl:method href="#isRootEnabled"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="database-instance-actions">
|
||||
<title>Database instance actions (action)</title>
|
||||
<para>
|
||||
Resizes instances and volumes and restarts instances.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#instanceAction">
|
||||
@@ -58,11 +65,14 @@
|
||||
</section>
|
||||
<section xml:id="databases">
|
||||
<title>Databases (databases)</title>
|
||||
<para>
|
||||
Creates, lists all, and deletes databases.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#databases">
|
||||
<wadl:method href="#createDatabase"/>
|
||||
<wadl:method href="#getDatabases"/>
|
||||
<wadl:method href="#listDatabases"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#databaseName">
|
||||
@@ -72,33 +82,45 @@
|
||||
</section>
|
||||
<section xml:id="user_management">
|
||||
<title>Users (users)</title>
|
||||
<para>
|
||||
Creates, lists all, and deletes users.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#users">
|
||||
<wadl:resource href="../wadls/databases-api/xsd/dbaas.wadl#users">
|
||||
<wadl:method href="#createUser"/>
|
||||
<wadl:method href="#getUsers"/>
|
||||
<wadl:method href="#listUsers"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#name">
|
||||
<wadl:resource href="../wadls/databases-api/xsd/dbaas.wadl#name">
|
||||
<wadl:method href="#deleteUser"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/databases-api/xsd/dbaas.wadl#root-dbaas">
|
||||
<wadl:method href="#createRoot"/>
|
||||
<wadl:method href="#isRootEnabled"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="flavors">
|
||||
<title>Flavors (flavors)</title>
|
||||
<para>
|
||||
Lists all flavors and shows details for a flavor, by ID.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#flavors">
|
||||
<wadl:method href="#getFlavors"/>
|
||||
<wadl:method href="#listFlavors"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#flavorId">
|
||||
<wadl:method href="#getFlavorById"/>
|
||||
<wadl:method href="#showFlavorById"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="datastores">
|
||||
<title>Datastores (datastores)</title>
|
||||
<title>Data stores (datastores)</title>
|
||||
<para>
|
||||
Lists data store versions, lists parameters for data stores, and
|
||||
shows parameter details for a data store version.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/databases-api/xsd/dbaas.wadl#datastore_versions">
|
||||
<wadl:method href="#listDatastoreVersions"/>
|
||||
@@ -112,9 +134,12 @@
|
||||
<wadl:method href="#showParameterDetails"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
</section>
|
||||
<section xml:id="configurations">
|
||||
<title>Configuration groups (configurations)</title>
|
||||
<para>
|
||||
Creates and lists all configuration groups.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/databases-api/xsd/dbaas.wadl#configurations">
|
||||
|
||||
@@ -240,7 +240,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the server was updated.
|
||||
The date and time when the resource was updated.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
@@ -291,7 +291,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the server, image, or backup was created.
|
||||
The date and time when the resource was created.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
|
||||
@@ -0,0 +1,319 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2011-2015 OpenStack Foundation, All Rights Reserved -->
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-volume-attachments-v2.1.wadl -->
|
||||
<!--*******************************************************-->
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/identity/api/v3"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<grammars>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-volume-attachments-v2.1">
|
||||
<resource id="version" type="#VersionDetails" path="//v2.1">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
&tenantIdRequestParameter;
|
||||
<resource id="Servers" path="servers">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
&serverIdRequestParameter;
|
||||
<resource path="os-volume_attachments"
|
||||
type="#Volumes" id="os-volume-attachments">
|
||||
<resource path="{attachment_id}"
|
||||
type="#VolumeAttachmentList"
|
||||
id="attachment_id">
|
||||
&attachment_idTemplateParameter;
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<!--*******************************************************-->
|
||||
<!-- Resource Types -->
|
||||
<!--*******************************************************-->
|
||||
<resource_type id="Volumes">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Volume attachment list">
|
||||
<para>
|
||||
A list of volume attachments that are associated with a
|
||||
server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<method href="#attachVolume"/>
|
||||
<method href="#listVolumeAttachments"/>
|
||||
</resource_type>
|
||||
<resource_type id="VolumeAttachmentList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Volume attachment list">
|
||||
<para>
|
||||
A list of volume attachments that are associated with a
|
||||
server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<method href="#getVolumeAttachmentDetails"/>
|
||||
<method href="#deleteVolumeAttachment"/>
|
||||
</resource_type>
|
||||
|
||||
<!--*******************************************************-->
|
||||
<!-- All Methods -->
|
||||
<!--****************************************************** -->
|
||||
<!-- Volume Actions -->
|
||||
<method name="POST" id="attachVolume">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Attach volume to server">
|
||||
<para role="shortdesc">
|
||||
Attaches a volume to a server.
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
You can attach a volume to a server with an
|
||||
<code>ACTIVE</code>, <code>PAUSED</code>,
|
||||
<code>SHUTOFF</code>, <code>VERIFY_RESIZE</code>, or
|
||||
<code>SOFT_DELETED</code> status.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
You can attach a volume to a server with a status that
|
||||
is not locked.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
You can attach a volume with a <code>available</code> status.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
You can attach a volume when its volume type supports
|
||||
volume attaching.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>Asynchronous Postconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
After successfully attaching a volume to a server, the
|
||||
volume status changes to <code>in-use</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
You can see the attached volume when you
|
||||
log in to the server.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>Troubleshooting</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
If the volume status remains in <code>available</code>
|
||||
state, the request failed. Ensure that you meet the
|
||||
preconditions and run the request again. If the
|
||||
request fails again, investigate the server and the
|
||||
volume status.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/attach-volume-to-server-req.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<param name="volumeId" style="template"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The UUID of the volume to attach.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="device" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Name of the device such as, <code>/dev/vdb</code>. Omit or set this
|
||||
parameter to null for auto-assignment, if supported. If you specify
|
||||
this parameter, the device must not exist in the guest operating system.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="volumeAttachment" style="template"
|
||||
type="xsd:dict">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A dictionary representation of a volume
|
||||
attachment.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/attach-volume-to-server-resp.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response> &commonFaults; &getFaults;
|
||||
<!-- Common, GET, postput, inProgress Faults--> &commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
<method name="GET" id="listVolumeAttachments">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List volume attachments">
|
||||
<para role="shortdesc">
|
||||
Lists the volume attachments for a server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json"
|
||||
element="csapi:attachvolume"/>
|
||||
</request>
|
||||
<response status="202">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/list-volume-attachments-resp.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response> &commonFaults; &getFaults;
|
||||
<!-- Common, GET, postput, inProgress Faults--> &commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
<method name="GET" id="getVolumeAttachmentDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show volume attachment details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a volume attachment.
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
The volume must be attached to the server.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json"
|
||||
element="csapi:attachvolume"/>
|
||||
</request>
|
||||
<response status="202">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/volume-attachment-detail-resp.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response> &commonFaults; &getFaults;
|
||||
<!-- Common, GET, postput, inProgress Faults--> &commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
<method name="DELETE" id="deleteVolumeAttachment">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Detach volume">
|
||||
<para role="shortdesc">
|
||||
Detaches a volume from a server.
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
The volume must be attached to the server.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
You can detach a volume when the server
|
||||
status is <code>ACTIVE</code>, <code>PAUSED</code>,
|
||||
<code>SHUTOFF</code>, <code>VERIFY_RESIZE</code>, or
|
||||
<code>SOFT_DELETED</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
You can detach a volume when its status
|
||||
is <code>in-use</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
You can detach a volume from a server with
|
||||
a status that is not locked.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
You cannot detach a root device volume.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>Asynchronous Postconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>After successfully detaching a volume,
|
||||
its status changes to <code>available</code>.
|
||||
</para></listitem>
|
||||
<listitem><para>The detached volume is no longer visible on
|
||||
the server.</para></listitem>
|
||||
</itemizedlist>
|
||||
<para>Troubleshooting</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
If the volume status remains in <code>available</code>
|
||||
state, the request failed. Ensure that you meet the
|
||||
preconditions and run the request again. If the
|
||||
request fails again, investigate whether another
|
||||
operation is running that causes a race condition.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
If you attempt to detach a root device volume, this
|
||||
operation returns the <code>Forbidden (403)</code>
|
||||
response code.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json"
|
||||
element="csapi:attachvolume"/>
|
||||
</request>
|
||||
<response status="202"/>
|
||||
<!-- Common, GET, postput, inProgress Faults--> &commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
</application>
|
||||
@@ -68,5 +68,449 @@
|
||||
<response status="415" xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml" element="dbaas:badMediaType"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
'>
|
||||
</response>'>
|
||||
<!ENTITY accountIdTemplateParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="accountId" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The account ID of the owner of the instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY instanceIdTemplateParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="instanceId" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID for the database instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY databaseNameTemplateParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="databaseName"
|
||||
style="template" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The name for the database.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY userNameTemplateParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="userName" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The name for the user.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY flavorIdTemplateParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="flavorId" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID for the flavor.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY datastoreNameTemplateParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="datastoreName" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The name of the data store for which to list versions.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY datastoreVersionIdTemplateParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="datastoreVersionId" style="template"
|
||||
type="xsd:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The UUID of the data store version.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY parameterNameTemplateParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="parameterName" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The name of the parameter for which to show details.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!-- REQUEST PARAMETERS -->
|
||||
<!ENTITY instanceRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="instance" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
An <code>instance</code> object.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY flavorRefRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="flavorRef" style="plain"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Reference (href), which is the actual URI to a
|
||||
flavor as it appears in the list flavors response.
|
||||
</para>
|
||||
<para>
|
||||
Rather than the flavor URI, you can also pass the
|
||||
flavor ID (integer) as the <code>flavorRef</code>
|
||||
value. For example, <code>1</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY sizeRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="size" style="plain" type="xsd:int"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The volume size, in gigabytes (GB). A valid value
|
||||
is from 1 to 50.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY databasesRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="databases" style="plain"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A <code>databases</code> object.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY instance-nameRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Name of the instance to create. A valid value is
|
||||
up to 255 characters long. All characters are
|
||||
permitted.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY databaseNameRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A database name.
|
||||
</para>
|
||||
<para>
|
||||
You cannot use the <code>lost+found</code>,
|
||||
<code>information_schema</code>, or <code>mysql</code> database
|
||||
name to create a database because these names are reserved for
|
||||
system databases.
|
||||
</para>
|
||||
<para>
|
||||
Valid characters in a database name are:
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
Upper and lower case letters.
|
||||
</listitem>
|
||||
<listitem>
|
||||
Numbers.
|
||||
</listitem>
|
||||
<listitem>
|
||||
<code>@</code>, <code>?</code>, <code>#</code>, and spaces
|
||||
except at the beginning or end of the database name.
|
||||
</listitem>
|
||||
<listitem>
|
||||
<code>_</code> is allowed anywhere in the database name.
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>
|
||||
You cannot use these characters in a database name:
|
||||
</para>
|
||||
<para>
|
||||
The maximum length of a database name is 64 characters.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY characterSetRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="characterSet" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A set of symbols and encodings. Default is <code>utf8</code>.
|
||||
</para>
|
||||
<para>
|
||||
For information about supported character sets and collations, see <link
|
||||
xlink:href="http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html">Character Sets
|
||||
and Collations in MySQL</link>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY collateRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="collate" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A set of rules for comparing characters in a character set.
|
||||
Default is <code>utf8_general_ci</code>.
|
||||
</para>
|
||||
<para>
|
||||
For information about supported character sets and collations, see <link
|
||||
xlink:href="http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html">Character Sets
|
||||
and Collations in MySQL</link>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY usersRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="users" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A <code>users</code> object.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY user-nameRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The user name for the database on instance creation.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY user-passwordRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="password"
|
||||
style="plain" type="xsd:string" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The password for those users on instance
|
||||
creation.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!-- RESPONSE PARAMETERS -->
|
||||
<!ENTITY instanceResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="instance" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
An <code>instance</code> object.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY flavorResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="flavor" style="plain"
|
||||
type="xsd:dict" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A <code>flavor</code> object, which includes the flavor ID
|
||||
(integer) and flavor relative links.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY sizeResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="size" style="plain" type="xsd:int"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The volume size, in gigabytes (GB). A valid value
|
||||
is from 1 to 50.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY databasesResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="databases" style="plain"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A <code>databases</code> object.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY instance-nameResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Name of the instance to create. A valid value is
|
||||
up to 255 characters long. All characters are
|
||||
permitted.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY databaseNameResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A database name.
|
||||
</para>
|
||||
<para>
|
||||
You cannot use the <code>lost+found</code>,
|
||||
<code>information_schema</code>, or <code>mysql</code> database
|
||||
name to create a database because these names are reserved for
|
||||
system databases.
|
||||
</para>
|
||||
<para>
|
||||
Valid characters in a database name are:
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
Upper and lower case letters.
|
||||
</listitem>
|
||||
<listitem>
|
||||
Numbers.
|
||||
</listitem>
|
||||
<listitem>
|
||||
<code>@</code>, <code>?</code>, <code>#</code>, and spaces
|
||||
except at the beginning or end of the database name.
|
||||
</listitem>
|
||||
<listitem>
|
||||
<code>_</code> is allowed anywhere in the database name.
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>
|
||||
You cannot use these characters in a database name:
|
||||
</para>
|
||||
<para>
|
||||
The maximum length of a database name is 64 characters.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY characterSetResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="characterSet" style="plain"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A set of symbols and encodings. Default is <code>utf8</code>.
|
||||
</para>
|
||||
<para>
|
||||
For information about supported character sets and collations, see <link
|
||||
xlink:href="http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html">Character Sets
|
||||
and Collations in MySQL</link>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY collateResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="collate" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A set of rules for comparing characters in a character set.
|
||||
Default is <code>utf8_general_ci</code>.
|
||||
</para>
|
||||
<para>
|
||||
For information about supported character sets and collations, see <link
|
||||
xlink:href="http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html">Character Sets
|
||||
and Collations in MySQL</link>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY usersResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="users" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A <code>users</code> object.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY user-nameResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" id="user-name" style="plain"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The user name for the database on instance creation.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY user-passwordResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="password"
|
||||
style="plain" type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The password for those users on instance
|
||||
creation.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user