Files
neutron-lib/api-ref/source/v2/extensions.inc
Brian Haley c28b3ab8fe Fix incorrect links for the filtering spec
The spec networking_general_api_information.html was moved
to api-ref in [0] but some of the links pointing to it
were not updated. This change makes all the refs consistent
and adds links where missing.

Also moved sync/async and bulk create sections lower to
group all the filtering, pagination and sorting sections
together since they are inter-related.

[0] https://review.opendev.org/c/openstack/neutron-lib/+/362877

Change-Id: I895cc9aaee2546b95e93150c134f350a50346447
2024-04-04 19:00:17 -04:00

87 lines
1.6 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.
.. include:: filtering-list.inc
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.
.. include:: filtering-show.inc
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