This patch brings the Networking API Reference to a repository under the neutron stadium. It is a part of the effort described here [1]: As we discussed in the stadium evolution [2], we plan to have the API stuff in neutron-lib, so the API reference is hosted on neutron-lib as well. The goal of this patch is to import converted RST API references. Cleanup is planned once this patch is merged. [1] https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan [2] https://review.openstack.org/312199 Change-Id: I6f2c4d476c31b252bfb181138505673f397639fc
57 lines
918 B
ReStructuredText
57 lines
918 B
ReStructuredText
.. -*- rst -*-
|
|
|
|
============
|
|
API versions
|
|
============
|
|
|
|
Lists information for all Networking API versions.
|
|
|
|
Show API v2 details
|
|
===================
|
|
|
|
.. rest_method:: GET /v2.0
|
|
|
|
Shows details for Networking API v2.0.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. .. rest_parameters:: parameters.yaml
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- location: location
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/networks/version-show-response.json
|
|
:language: javascript
|
|
|
|
List API versions
|
|
=================
|
|
|
|
.. rest_method:: GET /
|
|
|
|
Lists information about all Networking API versions.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:300,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. .. rest_parameters:: parameters.yaml
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/networks/versions-list-response.json
|
|
:language: javascript
|