da4009d8ad
This patches adds the basic architecture to adopt api ref in tree and a new tox command to build api ref for testing. A new api ref gate job will be added to verify the format which will be tracked by another commit against project-config. blueprint: api-ref-in-tree Change-Id: Idffbdc9325868a3dcd6a9bd7f90f030fd52ee0dc
36 lines
658 B
HTML
36 lines
658 B
HTML
============
|
|
API Versions
|
|
============
|
|
|
|
Concepts
|
|
========
|
|
|
|
The Zaqar API only supports ''major versions'' expressed in request URLs.
|
|
|
|
|
|
List Major Versions
|
|
===================
|
|
|
|
.. rest_method:: GET /
|
|
|
|
This fetches all the information about all known major API versions in
|
|
the deployment. Links to more specific information will be provided
|
|
for each API version.
|
|
|
|
|
|
Normal response codes: 300
|
|
Error response codes: serviceUnavailable (503)
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- versions: versions
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/versions-list-response.json
|
|
:language: javascript
|