b0577ae97e
Doc style: * use tildes for heading 2 (following the rst convention); * break source lines exceeded 79 characters (rst convention); * remove unneccessary blank lines: * 4 blank lines between sections; * 2 blank lines between sub-sections; * 1 blank line between paragraphs in a section/subsection; * no blank lines at the bottom of a source file. * add a space after commas in the middle of a line; Instances API: * change the order to match the description at the begin; * add "Update instance name"; * add "Upgrade datastore version". Change-Id: I3520e42f6ad97cb30632cf05241cec316409c9be Signed-off-by: Zhao Chao <zhaochao1984@gmail.com>
53 lines
1.1 KiB
ReStructuredText
53 lines
1.1 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
============
|
|
API versions
|
|
============
|
|
|
|
Lists information for all Database Service API versions and shows
|
|
Database Service v1.0 details.
|
|
|
|
|
|
List versions
|
|
~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /
|
|
|
|
Lists information about all Database Service API versions.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
|
|
instanceFault(500), notImplemented(501), serviceUnavailable(503)
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/db-versions-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Show version details
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v1.0
|
|
|
|
Shows details for the Database Service API v1.0.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
|
|
instanceFault(500), notImplemented(501), serviceUnavailable(503)
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/db-version-response.json
|
|
:language: javascript
|