trove/api-ref/source/api-versions.inc
shangxiaobj e54c46e312 [api-ref] Add fault names for the error response codes
Error response codes with fault names will be easier for understanding.

Change-Id: I5970cb6d40cf5793f024fd5d46b0da8f24bee0d6
2018-01-25 00:25:55 +00:00

81 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