On 04/07/2010 07:33 PM, Mark McLoughlin wrote:
Hi,
I've made a first attempt at documenting the REST API here:
https://fedorahosted.org/rhevm-api/wiki/ApiReference
https://fedorahosted.org/rhevm-api/wiki/VirtualMachinesCollection
Basically, I just wanted to get a feel for how sane the semantics sound
when described in prose. It seems like a fine start to me?
Geert will notice that I borrowed liberally from his API reference
style :-)
Cool :)
I would like both APIs to follow an identical schema as this way my
users have an easy way of migrating to the "official" API once it is
released as part of the product. Some current differences:
- Right now you're doing a minimal mapping of the attributes, while i
chose to make everything available. Any reason for that?
- I'm using names for linked objects (e.g. host, cluster) while you
use GUIDs. But as per the discussion about immutable URLs, i will update
this so that i uses GUIDs as well.
- (Potential bike shed painting alert).. You seem to be using
mixedCase for the attributes while i'm using lowercase. It a quick
consensus likely? Is there a prevailing convention in other REST APIs?
Regards,
--
Geert Jansen, Product Marketing Manager EMEA
Red Hat S.r.L. T: +39 348 1980079
Via Antonio da Recanate 1 E: gjansen(a)redhat.com
Milan 20124, Italy
Calculate your virtualization TCO at bit.ly/7CKhUm