openstack/api-site
Code Issues Proposed changes

Merge "Add doc for configuration-attach cmd"

Browse Source
This commit is contained in:
Jenkins 2015-07-14 19:22:02 +00:00 committed by Gerrit Code Review
commit ee7c9be6d2
5 changed files with 58 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api-ref/src/docbkx/ch_database-v1.xml
View File

@ -34,6 +34,7 @@
href="../wadls/databases-api/xsd/dbaas.wadl#instanceId">
<wadl:method href="#getInstanceById"/>
<wadl:method href="#deleteInstance"/>
<wadl:method href="#attachConfigGroup"/>
<wadl:method href="#listConfigDefaults"/>
</wadl:resource>
<wadl:resource

40
api-ref/src/wadls/databases-api/xsd/dbaas.wadl
View File

@ -62,6 +62,7 @@
</wadl:doc>
</param>
<method href="#getInstanceById"/>
<method href="#attachConfigGroup"/>
<method href="#deleteInstance"/>
<method href="#listConfigDefaults"/>
<resource id="instanceAction" path="action">
@ -1601,4 +1602,43 @@
</representation>
</response> &commonFaults; &getFaults;
</method>
<method name="PUT" id="attachConfigGroup">
<wadl:doc xml:lang="EN" title="Attach configuration group"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Attaches a configuration group to
a specified instance.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/db-attach-config-grp-request-json-http.txt"/>
<xsdxt:code
href="samples/db-attach-config-grp-request.json"/>
</wadl:doc>
<param name="configuration" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
ID of the configuration group that you want to attach to the instance.
</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="samples/db-attach-config-grp-response-json-http.txt"
/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; &postPutFaults;
</method>
</application>

7
api-ref/src/wadls/databases-api/xsd/samples/db-attach-config-grp-request-json-http.txt Normal file
View File

@ -0,0 +1,7 @@
PUT /v1.0/1234/instances/4c93c73b-d6d0-47d7-b8c6-b699d19d7de9 HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json

5
api-ref/src/wadls/databases-api/xsd/samples/db-attach-config-grp-request.json Normal file
View File

@ -0,0 +1,5 @@
{
"instance": {
"configuration": "2aa51628-5c42-4086-8682-137caffd2ba6"
}
}

5
api-ref/src/wadls/databases-api/xsd/samples/db-attach-config-grp-response-json-http.txt Normal file
View File

@ -0,0 +1,5 @@
HTTP/1.1 202 OK
Content-Type: application/json
Content-Length: 0
Date: Mon, 13 Jul 2015 19:53:04 GMT