trove/api-ref/source/api-versions.inc
Amrith Kumar 3b0d1ea25d Adds the api-ref migrated RST + YAML files
With this email[0], you must migrate API reference docs into RST. The
conf.py and the tox environment are also cribbed from nova.

Still need to retain the install_command in tox.ini, otherwise the
api-ref job fails.

[0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html

Co-Authored-By: Anne Gentle <agentle@cisco.com>
Co-Authored-By: Amrith Kumar <amrith@tesora.com>

Change-Id: I3315261aa18729fa7a6aa79d4a1d6c24de1e2c6b
2016-08-17 17:46:41 -04:00

77 lines
834 B
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:413,405,404,403,401,400,422,503,500,501,
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:413,405,404,403,401,400,422,503,500,501,
Response Example
----------------
.. literalinclude:: samples/db-version-response.json
:language: javascript