tacker/api-ref/source/v1/versions.inc
Naoya Harada 4a0b5c4569 API reference documentation
This patch follows on api-ref skeleton [1] and brings the
NFV Orchestration API reference content to the repository.
It is a part of the effort described in [2].

[1] https://review.openstack.org/#/c/332183
[2] https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan

Change-Id: Ia2d91adb33f10df9073de74eb82cc19be29a3da2
2016-12-01 14:17:47 +09:00

45 lines
687 B
ReStructuredText

.. -*- rst -*-
============
API versions
============
Lists information of NFV Orchestration API versions.
List versions
=============
.. rest_method:: GET /
Lists NFV Orchestration API versions.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 500
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- versions: versions
- status: version_status
- id: version_id
- links: version_links
- href: version_href
- rel: version_rel
Response Example
----------------
.. literalinclude:: samples/versions/versions-list-response.json
:language: javascript