[openstack-dev] [api][nova][ironic] Microversion API HTTP header

Dean Troyer dtroyer at gmail.com
Thu Jun 25 19:21:39 UTC 2015


On Thu, Jun 25, 2015 at 7:10 AM, Sean Dague <sean at dague.net> wrote:

> For someone that's extremely familiar with what they are doing, they'll
> understand that http://service.provider/compute is Nova, and can find
> their way to Nova docs on the API. But for new folks, I can only see
> this adding to confusion.
>

Anyone using the REST API directly has already gotten an endpoint from the
service catalog using the service type (I'm ignoring the deprecated 'name'
field).  The version header should match up directly to the type used to
get the endpoint.


> Being extra, and possibly redundantly, explicit here eliminates
> confusion. Our API is communication to our users, and I feel like at
> every point we should err on the side of what's going to be the most
> clear under the largest number of scenarios.
>

I agree with this sentiment, and extra hard in that we need to be as
consistent across all of out APIs as possible.

dt

-- 

Dean Troyer
dtroyer at gmail.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20150625/a9d9769f/attachment.html>


More information about the OpenStack-dev mailing list