api-ref: complete verification for extensions resource
This completes all 4 phases of the extensions resource. * List method was added * Error codes updated as exist in code * Updates parameters.yaml to match actual descriptions for parameters * Update body to be a lot stronger about what our deprecation means and why. Part of bp:api-ref-in-rst Change-Id: I003fc1cc84cd429fbdc0c4f0847be81d920d3561
This commit is contained in:
2 changed files with 80 additions and 39 deletions
@@ -1,8 +1,4 @@
.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
=====================================
Extensions (extensions) (DEPRECATED)
@@ -11,9 +7,59 @@
Lists available extensions and shows information for an extension, by
alias.
OpenStack Compute API v2.0 supports extensions. However, extensions are
deprecated in Compute API v2.1. For information about extensions, see
`Extensions <http://developer.openstack.org/api-guide/compute/extensions.html>`__.
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.
For information about extensions, see `Extensions
<http://developer.openstack.org/api-guide/compute/extensions.html>`__.
List Extensions
===============
.. rest_method:: GET /v2.1/{tenant_id}/extensions
Lists all extensions to the API.
Normal response codes: 200
Error response codes: unauthorized(401)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
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/all_extensions/extensions-list-resp.json
:language: javascript
Show Extension Details
======================
@@ -22,10 +68,9 @@ Show Extension Details
Shows details for an extension, by alias.
Normal response codes: 200,203
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Error response codes: unauthorized(401), itemNotFound(404)
Request
-------
@@ -41,14 +86,16 @@ Response
.. rest_parameters:: parameters.yaml
- extension: extension
- name: name
- name: extension_name
- alias: alias
- links: links
- links: extension_links
- namespace: namespace
- description: description
- description: extension_description
- updated: updated
**Example Show Extension Details: JSON response**
**Example Show Extension Details**
Shows details about the ``os-agents`` extension.
.. literalinclude:: ../../doc/api_samples/extension-info/extensions-get-resp.json
:language: javascript
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.