[openstack-dev] [Keystone][Marconi][Oslo] Discoverable home document for APIs (Was: Re: [Nova][Glance] Support of v1 and v2 glance APIs in Nova)

Dolph Mathews dolph.mathews at gmail.com
Mon Nov 25 22:50:33 UTC 2013

On Mon, Nov 25, 2013 at 2:41 AM, Flavio Percoco <flavio at redhat.com> wrote:

> On 25/11/13 09:28 +1000, Jamie Lennox wrote:
>> So the way we have this in keystone at least is that querying GET / will
>> return all available API versions and querying /v2.0 for example is a
>> similar result with just the v2 endpoint. So you can hard pin a version
>> by using the versioned URL.
>> I spoke to somebody the other day about the discovery process in
>> services. The long term goal should be that the service catalog contains
>> unversioned endpoints and that all clients should do discovery. For
>> keystone the review has been underway for a while now:
>> https://review.openstack.org/#/c/38414/ the basics of this should be
>> able to be moved into OSLO for other projects if required.
> Did you guys create your own 'home document' language? or did you base
> it on some existing format? Is it documented somewhere? IIRC, there's
> a thread where part of this was discussed, it was related to horizon.
> I'm curious to know what you guys did and if you knew about
> JSON-Home[0] when you started working on this.

It looks like our multiple choice response might predate Nottingham's
proposal, but not by much. In keystone, it's been stable since I joined the
project, midway through the diablo cycle (summer 2011). I don't know any
more history than that, but I've CC'd Jorge Williams, who probably knows.

I really like Nottingham's approach of adding relational links from the
base endpoint, I've been thinking about doing the same for keystone for
quite a while.

> We used json-home for Marconi v1 and we'd want the client to work in a
> 'follow your nose' way. Since, I'd prefer OpenStack modules to use the
> same language for this, I'm curious to know why - if so - you
> created your own spec, what are the benefits and if it's documented
> somewhere.

Then why didn't Marconi follow the lead of one of the other projects? ;)

I completely agree though - standardized version discovery across the
ecosystem would be fantastic.

> Cheers,
> FF
> [0] http://tools.ietf.org/html/draft-nottingham-json-home-02
> --
> @flaper87
> Flavio Percoco
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20131125/830b2fbc/attachment.html>

More information about the OpenStack-dev mailing list