[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
Fri Dec 6 18:48:31 UTC 2013


On Mon, Nov 25, 2013 at 4:25 PM, Jamie Lennox <jamielennox at redhat.com>wrote:

> To most of your questions i don't know the answer as the format was in
> place before i started with the project. I know that it is similar (though
> not exactly the same) as nova's but not where they are documented (as they
> are version independent)
>
> I can tell you it looks like:
>
> {
>   "versions": {
>     "values": [
>       {
>         "status": "stable",
>         "updated": "2013-03-06T00:00:00Z",
>         "media-types": [
>           {
>             "base": "application\/json",
>             "type": "application\/vnd.openstack.identity-v3+json"
>           },
>           {
>             "base": "application\/xml",
>             "type": "application\/vnd.openstack.identity-v3+xml"
>           }
>         ],
>         "id": "v3.0",
>         "links": [
>           {
>             "href": "http:\/\/localhost:5000\/v3\/",
>             "rel": "self"
>           }
>         ]
>       },
>       {
>         "status": "stable",
>         "updated": "2013-03-06T00:00:00Z",
>         "media-types": [
>           {
>             "base": "application\/json",
>             "type": "application\/vnd.openstack.identity-v2.0+json"
>           },
>           {
>             "base": "application\/xml",
>             "type": "application\/vnd.openstack.identity-v2.0+xml"
>           }
>         ],
>         "id": "v2.0",
>         "links": [
>           {
>             "href": "http:\/\/localhost:5000\/v2.0\/",
>             "rel": "self"
>           },
>           {
>             "href": "http:\/\/docs.openstack.org
> \/api\/openstack-identity-service\/2.0\/content\/",
>             "type": "text\/html",
>             "rel": "describedby"
>           },
>           {
>             "href": "http:\/\/docs.openstack.org
> \/api\/openstack-identity-service\/2.0\/identity-dev-guide-2.0.pdf",
>             "type": "application\/pdf",
>             "rel": "describedby"
>           }
>         ]
>       }
>     ]
>   }
> }
>

The above is keystone's unversioned multiple choice response. I just wrote
docs for v3's existing version description response, which is closely based
on the above:

  https://review.openstack.org/#/c/60576/


>
> ----- Original Message -----
> > From: "Flavio Percoco" <flavio at redhat.com>
> > To: "OpenStack Development Mailing List (not for usage questions)" <
> openstack-dev at lists.openstack.org>
> > Sent: Monday, 25 November, 2013 6:41:42 PM
> > Subject: [openstack-dev] [Keystone][Marconi][Oslo] Discoverable home
> document for APIs (Was: Re: [Nova][Glance]
> > Support of v1 and v2 glance APIs in Nova)
> >
> > 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.
> >
> > 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.
> >
> > 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
> >
>
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>



-- 

-Dolph
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20131206/94792909/attachment.html>


More information about the OpenStack-dev mailing list