API consistency

Martyn Taylor mtaylor at redhat.com
Wed Oct 3 16:38:29 UTC 2012


Thanks for making a start on this:

we should consolidate this document with the guide we had previously: 
https://www.aeolusproject.org/redmine/projects/aeolus/wiki/Conductor_Image_Management_API

I've also got a ton of things that need consideration that are in 
etherpad form: http://etherpad-aeolusproject.rhcloud.com/p/AeolusAPIs

Our etherpad is down atm, but when we get it running I'll start moving 
the stuff into the wiki page.

Cheers

Martyn

On 10/03/2012 04:32 PM, Jiří Stránský wrote:
> Hi everyone,
>
> we'd like to make API more consistent and we need to do as much of 
> this as possible in a short time. The proposed solutions are based on 
> chats with mtaylor and pblaho and on what I think we agreed on IRC 
> yesterday. Please speak up if you feel the solutions are wrong, as 
> tomorrow I'm starting to implement them :)
>
> Here's an API style guide draft: 
> https://www.aeolusproject.org/redmine/projects/aeolus/wiki/API_Style_Guide
>
>
> The most important things that I'm going to focus on in upcoming days 
> are:
>
> * Changing all remaining 'url' attributes to 'href' when linking to 
> other resources (IME and Deltacloud already use href consistently),
>
> * Making body of all error responses follow the structure that is 
> described in the style guide ^^^ (don't mind the spaces in <code> tags 
> there, I couldn't get Redmine to display it well with the tags written 
> properly).
>
> Next up, I'd like to change this:
>
> * CREATE requests to return 201
>
> * DELETE requests to return 204 with no response body
>
> J.





More information about the aeolus-devel mailing list