[Openstack] describing APIs for OpenStack consumers
    Jorge Williams 
    jorge.williams at rackspace.com
       
    Tue Oct 25 23:17:28 UTC 2011
    
    
  
Totally agree.  The goal is to create narrative documents that devs can read etc.  The WADL is just there to fill in the nitty gritty details in a consistent way.
-jOrGe W.
On Oct 25, 2011, at 5:34 PM, Caitlin Bestler wrote:
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/7209de65/attachment.html>
    
    
More information about the Openstack
mailing list