diff options
| author | Sean Dague <sean@dague.net> | 2016-04-12 09:03:46 -0400 |
|---|---|---|
| committer | Sean Dague <sean@dague.net> | 2016-04-13 07:34:45 -0400 |
| commit | d4e27714405e064ba8f62070e8c48d7fa71b6996 (patch) | |
| tree | bd8b560fdc3864ea1c121b069926cd6b1d569556 /api-ref/source/versions.inc | |
| parent | f1fa7eb15a8b4a081d8d8afd3e6d80302c20e39e (diff) | |
| download | nova-d4e27714405e064ba8f62070e8c48d7fa71b6996.tar.gz | |
Import RST files for documentation
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.
Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
Diffstat (limited to 'api-ref/source/versions.inc')
| -rw-r--r-- | api-ref/source/versions.inc | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/api-ref/source/versions.inc b/api-ref/source/versions.inc new file mode 100644 index 0000000000..4971977c3d --- /dev/null +++ b/api-ref/source/versions.inc @@ -0,0 +1,77 @@ +.. -*- rst -*- + +============ +API Versions +============ + +Lists information for all API versions. + +List Api Versions +================= + +.. rest_method:: GET / + +Lists information about all Compute API versions. + +Normal response codes: 200,300 + +Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), +unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) + +Request +^^^^^^^ + +Response +^^^^^^^^ + +**Example List Api Versions: JSON request** + +.. literalinclude:: ../../doc/api_samples/versions/versions-list-resp.json + :language: javascript + +Show Api V2.1 +============= + +.. rest_method:: GET /v2.1 + +Show information about Compute API v2.1. + +Normal response codes: 200 + +Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), +unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) + +Request +^^^^^^^ + +Response +^^^^^^^^ + +**Example Show Api V2.1: JSON request** + +.. literalinclude:: ../../doc/api_samples/versions/versions-v21-show-resp.json + :language: javascript + +Show Api V2 +=========== + +.. rest_method:: GET /v2 + +Show information about Compute API v2. + +Normal response codes: 200 + +Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), +unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) + +Request +^^^^^^^ + +Response +^^^^^^^^ + +**Example Show Api V2: JSON request** + +.. literalinclude:: ../../doc/api_samples/versions/versions-v2-show-resp.json + :language: javascript + |