0ac922ece1
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
82 lines
1.4 KiB
ReStructuredText
82 lines
1.4 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
==========
|
|
Extensions
|
|
==========
|
|
|
|
Lists available Networking API v2.0 extensions and shows details
|
|
for an extension.
|
|
|
|
List extensions
|
|
===============
|
|
|
|
.. rest_method:: GET /v2.0/extensions
|
|
|
|
Lists available extensions.
|
|
|
|
Extensions introduce features and vendor-specific functionality to
|
|
the API.
|
|
|
|
The response shows the extension name and its alias. To show
|
|
details for an extension, you specify the alias.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,
|
|
|
|
Request
|
|
-------
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- updated: updated
|
|
- description: description
|
|
- links: links
|
|
- alias: alias
|
|
- extension: extension
|
|
- name: name
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/extensions/extensions-list-response.json
|
|
:language: javascript
|
|
|
|
Show extension details
|
|
======================
|
|
|
|
.. rest_method:: GET /v2.0/extensions/{alias}
|
|
|
|
Shows details for an extension, by alias.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- alias: alias
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- updated: updated
|
|
- description: description
|
|
- links: links
|
|
- alias: alias
|
|
- extension: extension
|
|
- name: name
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/extensions/extension-show-response.json
|
|
:language: javascript
|
|
|