openstack/nova
Code Issues Proposed changes

Merge "remove archaic references to XML in api"

Browse Source
This commit is contained in:
Jenkins 2016-01-04 03:35:04 +00:00 committed by Gerrit Code Review
commit 967c8c6fca
1 changed files with 1 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/addmethod.openstackapi.rst
View File

@ -42,11 +42,7 @@ Action methods take parameters that are sucked out of the URL by mapper.connect(
Serialization
-------------
Actions return a dictionary, and wsgi.Controller serializes that to JSON or XML based on the request's content-type.
If you define a new controller, you'll need to define a ``_serialization_metadata`` attribute on the class, to tell wsgi.Controller how to convert your dictionary to XML. It needs to know the singular form of any list tag (e.g. ``<servers>`` list contains ``<server>`` tags) and which dictionary keys are to be XML attributes as opposed to subtags (e.g. ``<server id="4"/>`` instead of ``<server><id>4</id></server>``).
See `nova/api/openstack/compute/servers.py` for an example.
Actions return a dictionary, and wsgi.Controller serializes that to JSON.
Faults
------