69719590b7
* Update api-ref structure * Added v2 * Backup list * Job list * Job Create Implements blueprint implement-api-ref-doc Change-Id: I643ca44565331ef9d0fc36189d60489523e3235e
38 lines
1021 B
HTML
38 lines
1021 B
HTML
============
|
|
API Versions
|
|
============
|
|
|
|
Freezer API supports v1 and v2.
|
|
|
|
|
|
List major versions
|
|
===================
|
|
|
|
.. rest_method:: GET /
|
|
|
|
Gets the home document.
|
|
|
|
This operation gets the home document.
|
|
|
|
The entire API is discoverable from a single starting point, the home document. To explore the entire API, you need to know only this one URI. This document is cacheable.
|
|
|
|
The home document lets you write clients by using relational links, so clients do not have to construct their own URLs. You can click through and view the JSON doc in your browser.
|
|
|
|
For more information about home documents, see `http://tools.ietf.org/html/draft-nottingham-json-home-02 <http://tools.ietf.org/html/draft-nottingham-json-home-02>`__.
|
|
|
|
|
|
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 |