[openstack-dev] [Nova] Blueprint: nova-api-validation-fw

Ken'ichi Ohmichi oomichi at mxs.nes.nec.co.jp
Tue Mar 26 10:09:18 UTC 2013


Hi,

This is RFC of blueprint nova-api-validation-fw.
  Blueprint: https://blueprints.launchpad.net/nova/+spec/nova-api-validation-fw
  Details  : https://wiki.openstack.org/wiki/NovaApiValidationFramework

Nova has many RESTful APIs, and not all API parameters are completely
validated. We would like to propose an API validation framework to
implement comprehensive validation.
The benefits of this framework will be the followings:
 * Validate every API parameters.
 * Unify both message format and HTTP code of error response, if
   the same cause.
   ex) ".. is too short.", ".. is too long.", ".. is not integer."
 * Clarify the API parameter definitions.
 * Clean up codes by merging error handling methods.

Using the JSON Schema library, we have created a prototype and examined
this API validation framework. The following URL is the prototype code.
  https://review.openstack.org/25358

We'd like to discuss the framework design, so any comments are welcome.


Thanks
Ken'ichi Ohmichi



More information about the OpenStack-dev mailing list