]> review.fuel-infra Code Review - openstack-build/cinder-build.git/commitdiff
doc: Fix wrong description about adding RESTful API
authorChangBo Guo(gcb) <eric.guo@easystack.cn>
Thu, 28 Jan 2016 05:40:00 +0000 (13:40 +0800)
committerChangBo Guo(gcb) <eric.guo@easystack.cn>
Wed, 17 Feb 2016 02:32:53 +0000 (10:32 +0800)
* Replace wrong example
* Remove outdated description about serialization

Change-Id: I1da230ce3b1979a0a337fc50d105de5f78f995bc

doc/source/devref/addmethod.openstackapi.rst

index 50bdeb06112545ec8a6926f8c9f507c5d4ebb899..001fc74483b425f857ed712649a275752cf23783 100644 (file)
@@ -35,7 +35,7 @@ Controllers and actions
 
 Controllers live in ``cinder/api/openstack``, and inherit from cinder.wsgi.Controller.
 
-See ``cinder/api/openstack/servers.py`` for an example.
+See ``cinder/api/v2/volumes.py`` for an example.
 
 Action methods take parameters that are sucked out of the URL by mapper.connect() or .resource().  The first two parameters are self and the WebOb request, from which you can get the req.environ, req.body, req.headers, etc.
 
@@ -44,10 +44,6 @@ 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 `cinder/api/openstack/servers.py` for an example.
-
 Faults
 ------