diff options
| author | Zhao Chao <zhaochao1984@gmail.com> | 2018-01-25 21:24:39 +0800 |
|---|---|---|
| committer | Zhao Chao <zhaochao1984@gmail.com> | 2018-01-25 22:55:13 +0800 |
| commit | b0577ae97e35d2fb82c12ffb2500891dbe46a6ef (patch) | |
| tree | daa73d9dce62d7dfa360d06a0155ca6d5c768bf1 /api-ref/source/api-versions.inc | |
| parent | fd5ad7f1122c6cff286f101dffbd5de45a5d51d8 (diff) | |
| download | trove-b0577ae97e35d2fb82c12ffb2500891dbe46a6ef.tar.gz | |
[api-ref] Update style and instances api.
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>
Diffstat (limited to 'api-ref/source/api-versions.inc')
| -rw-r--r-- | api-ref/source/api-versions.inc | 44 |
1 files changed, 8 insertions, 36 deletions
diff --git a/api-ref/source/api-versions.inc b/api-ref/source/api-versions.inc index cf9f371f..a795bf91 100644 --- a/api-ref/source/api-versions.inc +++ b/api-ref/source/api-versions.inc @@ -9,18 +9,17 @@ 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) +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 @@ -32,32 +31,18 @@ Response Example - - - - - - - - - - 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) - - - +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 @@ -65,16 +50,3 @@ Response Example .. literalinclude:: samples/db-version-response.json :language: javascript - - - - - - - - - - - - - |