deltacloud-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject REST API docs - IN PROGRESS and request for comments
Date Fri, 15 Jul 2011 15:56:31 GMT

This patch contains the *still in progress* documentation update for the deltacloud website.
I haven't been able to finish the docs by the deadline I set myself (today) - the process
is much more time consuming than I expected. I am invoking every API call with curl so that
i can accurately capture request/response; this is also exposing issues with the API (e.g.
the response codes for blob metadata that I sent a patch for).

This is *entirely* a request for initial comments and will not be committed. I've transferred
the existing deltacloud REST API (that we submitted to DMTF CMWG) to .mdown format. You need
to run 'webby' in /path/to/deltacloud/site and then the REST API can be seen at /path/to/deltacloud/site/output/api2.html.
The most complete section and which should be used for making comments is '4.3 Blob Storage'.
It contains 'example requests' and 'server response' for every available API call. 

I still need to add Firewalls collection and then go through and add 'example request' and
'server response' to every call in all other collections. After this I will add 'developer
instructions' - right now I'm thinking about a 'How to contribute - dev setup' section (setting
up git, basic git workflow how to make patches, send them etc etc) and then also a 'Guidelines
for a new driver'. Anything else that might be useful?

thanks, marios

View raw message