[Openstack] describing APIs for OpenStack consumers

Caitlin Bestler Caitlin.Bestler at nexenta.com
Tue Oct 25 22:34:00 UTC 2011


WADL sounds like a wonderful validation tool.

But shouldn't our primary goal be finding a consistent way to describe the APIs
for *application developers*.

Syntax tools, whether ancient notations like BNF or the latest XML concoction only tell you the syntax of the operation.
There also has to be consistent information that provides information to the reader as to when and why they would use
this specific operation, not just how to format it.

There is also a tendency of syntax oriented tools to omit vital state information,  particularly the expected sequence of operations.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack/attachments/20111025/5f6895f1/attachment.html>


More information about the Openstack mailing list