openstack/nova
Code Issues Proposed changes

Remove XML description from extension concept

Browse Source 
XML API interface has been already removed from Nova completely,
and its description of the extension concept becomes meaningless now.
So this patch removes it.

A small amount of the JSON description is left. The details are
trimmed down, as we're actually trying to get people away from
extensions as a concept.

A big warning to that effect is added into the document.

Partially implements blueprint complete-todo-in-api-concept-doc

Change-Id: Icf8bf87f38733ba03cf5ce1225594b0b282fde56
This commit is contained in:
Ken'ichi Ohmichi 2015-12-08 05:46:35 +00:00 committed by Sean Dague
parent da3001bc80
commit 32ce20c41c
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
api-guide/source/extensions.rst
View File

@ -12,17 +12,16 @@ version might not be available in another.
Extensions may also be queried individually by their unique alias. This Extensions may also be queried individually by their unique alias. This
provides the simplest method of checking if an extension is available provides the simplest method of checking if an extension is available
because an unavailable extension issues an itemNotFound (404) response. because an unavailable extension issues an itemNotFound (404)
response.
Extensions may define new data types, parameters, actions, headers, Extensions may define new data types, parameters, actions, headers,
states, and resources. In XML, additional elements and attributes can be states, and resources.
defined. These elements must be defined in the namespace for the
extension. In JSON, the alias must be used. The volumes element is NOTE: Extensions is a deprecated concept in Nova and their support
defined in the ``RS-CBS`` namespace. Extended headers are always will be removed in a future version. If your product or cloud relies
prefixed with ``X-`` followed by the alias and a dash: on extensions you should work on getting those features into the main
(``X-RS-CBS-HEADER1``). States and parameters must be prefixed with the upstream project.
extension alias followed by a colon. For example, an image might be in
the ``RS-PIE:PrepareShare`` state.
Important Important
~~~~~~~~~ ~~~~~~~~~
@ -146,4 +145,3 @@ extended request.
"href":"https://cbs.api.rackspacecloud.com/12934/volumes/19" "href":"https://cbs.api.rackspacecloud.com/12934/volumes/19"
} }
} }