Open Stack

What is the point of the guideline if we're not able to influence some of the biggest projects out there, that would keep growing with what they have..

Maybe we should add a note in each of those guidelines saying some examples exist where SERVICE_TYPE has been replaced by PROJECT_NAME for these headers; however, this "anomaly" is only where projects have/support multiple controllers, under different SERVICE_TYPEs. It should be explicit that guidelines recommend SERVICE_TYPE (as Dean stated) and do not recommend the PROJECT_NAME; and that the main purpose of inclusion of these names at all is to distinguish the headers when they are being recorded for some support purposes, etc; amongst all the OpenStack REST API calls.

--
Goutham



From: Dean Troyer <dtroyer at gmail.com<mailto:dtroyer at gmail.com>>
Reply-To: "OpenStack Development Mailing List (not for usage questions)" <openstack-dev at lists.openstack.org<mailto:openstack-dev at lists.openstack.org>>
Date: Wednesday, January 27, 2016 at 3:31 PM
To: "OpenStack Development Mailing List (not for usage questions)" <openstack-dev at lists.openstack.org<mailto:openstack-dev at lists.openstack.org>>
Subject: Re: [openstack-dev] [api] service type vs. project name for use in headers

On Wed, Jan 27, 2016 at 1:47 PM, michael mccune <msm at redhat.com<mailto:msm at redhat.com>> wrote:
i am not convinced that we would ever need to have a standard on how these names are chosen for the header values, or if we would even need to have header names that could be deduced. for me, it would be much better for the projects use an identifier that makes sense to them, *and* for each project to have good api documentation.

I think we would be better served in selecting these things thinking about the API consumers first.  We already have  enough for them to wade through, the API-WG is making great gains in herding those particular cats, I would hate to see giving back some of that here.

so, instead of using examples where we have header names like "OpenStack-Some-[SERVICE_TYPE]-Header", maybe we should suggest "OpenStack-Some-[SERVICE_TYPE or PROJECT_NAME]-Header" as our guideline.

I think the listed reviews have it right, only referencing service type.  We have attempted to reduce the visible surface area of project names in a LOT of areas, I do not think this is one that needs to be an exception to that.

Projects will do what they are going to do, sometimes in spite of guidelines.  This does not mean that the guidelines need to bend to match that practice when it is at odds with larger concerns.

In this case, the use of service type as the primary identifier for endpoints and API services is well established, and is how the service catalog has and will always work.

dt

--

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