Hi Ward, On 03/12/2013 01:14 AM, ward_har...@dell.com wrote: > I've been working on a proposal for a RESTful Crowbar API for a few days. > It's starting point is the various API/routing discussions that have been > going on. I added some things I've learned over time and folded in best > practices from exemplary REST APIs like developer.github.com and Netflix. > It's not complete but I think there's enough there for an initial review. The > markdown documents are at: > > https://s3.amazonaws.com/wkh-mumble-api/cbapi.md > https://s3.amazonaws.com/wkh-mumble-api/attribapi.md > https://s3.amazonaws.com/wkh-mumble-api/attrib_types.md > https://s3.amazonaws.com/wkh-mumble-api/barclampapi.md
Very happy to see that you've started working on the API documentation. Is there any ETA on when this will be finalized? > I suppose they really belong on the project wiki but I didn't think of that > until Wayne mentioned it. Since I'm already late making them available I'll > leave them on S3 for now and move to the wiki tomorrow. I think they really belong in the devguide in git, so they automatically end up in the offline product documentation too. I personally also prefer to have everything in git, as I find it hard to maintain the wiki - they are too loosely coupled with the code and hence often bit-rot over time. I've taken the liberty to move your draft into git, along with some edits - hope you don't mind! The pull request is at: https://github.com/crowbar/crowbar/pull/1760 Cheers, James T. _______________________________________________ Crowbar mailing list Crowbar@dell.com https://lists.us.dell.com/mailman/listinfo/crowbar For more information: http://crowbar.github.com/
