openstack/api-site
Code Issues Proposed changes

Merge "Add doc for configuration-list cmd"

Browse Source
This commit is contained in:
Jenkins 2015-07-08 21:49:35 +00:00 committed by Gerrit Code Review
commit d569c96ae3
5 changed files with 62 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

@ -116,6 +116,7 @@
<wadl:resource
href="../wadls/databases-api/xsd/dbaas.wadl#configurations">
<wadl:method href="#createConfigGroup"/>
<wadl:method href="#listConfigGroups"/>
</wadl:resource>
</wadl:resources>
</section>

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

@ -166,6 +166,7 @@
</resource>
<resource id="configurations" path="configurations">
<method href="#createConfigGroup"/>
<method href="#listConfigGroups"/>
</resource>
</resource>
</resource>
@ -1534,4 +1535,38 @@
</representation>
</response> &commonFaults; &getFaults;
</method>
<method name="GET" id="listConfigGroups">
<wadl:doc xml:lang="EN" title="List configuration groups"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Lists all configuration groups.
</para>
<para>
The list includes the associated datastore and datastore
version for each configuration group.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/db-list-cfg-groups-request-json-http.txt"
/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/db-list-cfg-groups-response-json-http.txt"/>
<xsdxt:code
href="samples/db-list-cfg-groups-response.json"
/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults;
</method>
</application>

7
api-ref/src/wadls/databases-api/xsd/samples/db-list-cfg-groups-request-json-http.txt Normal file
View File

@ -0,0 +1,7 @@
GET /v1.0/1234/configurations 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-list-cfg-groups-response-json-http.txt Normal file
View File

@ -0,0 +1,5 @@
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 426
Date: Tue, 07 Jul 2012 19:53:04 GMT

14
api-ref/src/wadls/databases-api/xsd/samples/db-list-cfg-groups-response.json Normal file
View File

@ -0,0 +1,14 @@
{
"configurations": [
{
"datastore_name": "mysql",
"updated": "2015-07-01T16:38:27",
"name": "group1",
"created": "2015-07-01T16:38:27",
"datastore_version_name": "5.6",
"id": "2aa51628-5c42-4086-8682-137caffd2ba6",
"datastore_version_id": "2dc7faa0-efff-4c2b-8cff-bcd949c518a5",
"description": null
}
]
}