nova/api-ref/source/extensions.inc
Takashi NATSUME e75598be31 api-ref: Fix a broken link
The link to the API extension document has been broken.
The API extension document does not exist currently,
so just remove the link.

Change-Id: I8920a00004528f5fa30d1b5a2f53ffa5f65f2ea8
2019-07-05 13:24:18 +09:00

92 lines
2.1 KiB
ReStructuredText

.. -*- rst -*-
=====================================
Extensions (extensions) (DEPRECATED)
=====================================
Lists available extensions and shows information for an extension, by
alias.
Nova originally supported the concept of API extensions, that allowed
implementations of Nova to change the API (add new resources, or
attributes to existing resource objects) via extensions. In an attempt
to expose to the user what was supported in a particular site, the
extensions resource provided a list of extensions and detailed
information on each. The net result was gratuitous differentiation in
the API that required all users of OpenStack clouds to write specific
code to interact with every cloud.
As such, the entire extensions concept is deprecated, and will be
removed in the near future.
List Extensions
===============
.. rest_method:: GET /extensions
Lists all extensions to the API.
Normal response codes: 200
Error response codes: unauthorized(401)
Response
--------
.. rest_parameters:: parameters.yaml
- extensions: extensions
- name: extension_name
- alias: alias
- links: extension_links
- namespace: namespace
- description: extension_description
- updated: updated
**Example List Extensions**
Lists all extensions to the API.
.. literalinclude:: ../../doc/api_samples/extension-info/extensions-list-resp.json
:language: javascript
Show Extension Details
======================
.. rest_method:: GET /extensions/{alias}
Shows details for an extension, by alias.
Normal response codes: 200
Error response codes: unauthorized(401), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- alias: alias
Response
--------
.. rest_parameters:: parameters.yaml
- extension: extension
- name: extension_name
- alias: alias
- links: extension_links
- namespace: namespace
- description: extension_description
- updated: updated
**Example Show Extension Details**
Shows details about the ``os-agents`` extension.
.. literalinclude:: ../../doc/api_samples/extension-info/extensions-get-resp.json
:language: javascript