[openstack-dev] [api] Request Validation - Stoplight

Amit Gandhi amit.gandhi at RACKSPACE.COM
Fri Oct 17 17:32:05 UTC 2014


Hi API Working Group

Last night at the Openstack Meetup in Atlanta, a group of us discussed how request validation is being performed over various projects and how some teams are using pecan wsmi, or warlock, jsonschema etc.

Each of these libraries have their own pro’s and con’s.  My understanding is that the API working group is in the early stages of looking into these various libraries and will likely provide guidance in the near future on this.

I would like to suggest another library to evaluate when deciding this.  Some of our teams have started to use a library named “Stoplight”[1][2] in our projects.  For example, in the Poppy CDN project, we found it worked around some of the issues we had with warlock such as validating nested json correctly [3].

Stoplight is an input validation framework for python.  It can be used to decorate any function (including routes in pecan or falcon) to validate its parameters.

Some good examples can be found here [4] on how to use Spotlight.

Let us know your thoughts/interest and we would be happy to discuss further on if and how this would be valuable as a library for API request validation in Openstack.


Thanks


Amit Gandhi
Senior Manager – Rackspace



[1] https://pypi.python.org/pypi/stoplight
[2] https://github.com/painterjd/stoplight
[3] https://github.com/stackforge/poppy/blob/master/poppy/transport/pecan/controllers/v1/services.py#L108
[4] https://github.com/painterjd/stoplight/blob/master/stoplight/tests/test_validation.py#L138

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20141017/a2253099/attachment.html>


More information about the OpenStack-dev mailing list