8dbdb028ac
This patch corrects Network v2.0 API extensions: - Change 'extensions' type from 'object' to 'array' - Change '{alias}' parameter from 'in:body' to 'in:path' Refactor code Change-Id: I2e64669224ab4a970c17cc192abdf08519b1576f Partially-Implements: blueprint neutron-in-tree-api-ref
84 lines
1.5 KiB
ReStructuredText
84 lines
1.5 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
==========
|
|
Extensions
|
|
==========
|
|
|
|
|
|
Extensions introduce features and vendor-specific functionality to
|
|
the API.
|
|
|
|
List extensions
|
|
===============
|
|
|
|
.. rest_method:: GET /v2.0/extensions
|
|
|
|
Lists available extensions.
|
|
|
|
Lists available Networking API v2.0 extensions and shows details
|
|
for an extension.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 401
|
|
|
|
Request
|
|
-------
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- extensions: extensions
|
|
- name: extension-name
|
|
- links: extension-links
|
|
- alias: extension-alias-body
|
|
- updated: extension-updated
|
|
- description: extension-description
|
|
|
|
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.
|
|
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: 401, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- alias: extensions-alias-path
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- extension: extension
|
|
- name: extension-name
|
|
- links: extension-links
|
|
- alias: extension-alias-body
|
|
- updated: extension-updated
|
|
- description: extension-description
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/extensions/extension-show-response.json
|
|
:language: javascript
|
|
|