openstack/nova
Code Issues Proposed changes

Add JSON-Schema note to api_plugins.rst

Browse Source 
Nova v2.1 API validates a request with JSON-Schema, and there are
some specific usage on that. This patch adds it to the rst file
for the implementation hint.

Change-Id: I4edac8b6b53d198f2a237bb163b8975528319c9b
This commit is contained in:
Ken'ichi Ohmichi 2015-09-02 07:14:42 +00:00
parent 96f6c1657a
commit 1caba68fd1
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/source/api_plugins.rst
View File

@ -123,6 +123,39 @@ code still needs modularity. Here are rules for how to separate modules:
in existing extended models. New extended attributes needn't any namespace
prefix anymore.
JSON-Schema
~~~~~~~~~~~
The v2.1 API validates a REST request body with JSON-Schema library.
Valid body formats are defined with JSON-Schema in the directory
'nova/api/openstack/compute/schemas'. Each definition is used at the
corresponding method with the ``validation.schema`` decorator like::
@validation.schema(schema.update_something)
def update(self, req, id, body):
....
Nova supports the extension of JSON-Schema definitions based on the
loaded API extensions for some APIs. Stevedore library tries to find
specific name methods which return additional parameters and extends
them to the original JSON-Schema definitions.
The following are the combinations of extensible API and method name
which returns additional parameters:
* Create a server API - get_server_create_schema()
* Update a server API - get_server_update_schema()
* Rebuild a server API - get_server_rebuild_schema()
* Resize a server API - get_server_resize_schema()
For example, keypairs extension(Keypairs class) contains the method
get_server_create_schema() which returns::
{
'key_name': parameter_types.name,
}
then the parameter key_name is allowed on Create a server API.
Support files
-------------