chop-dbhi / data-models-service

Service for consuming files in the data models format.
1 stars 1 forks source link

Expose semver of package in `User-Agent` header field? #1

Closed gracebrownecodes closed 9 years ago

bruth commented 9 years ago

What is the motivation for this? Why the User-Agent?

gracebrownecodes commented 9 years ago

Motivation described in chop-dbhi/data-models#80

gracebrownecodes commented 9 years ago

User-Agent header seems like the place suggested by several resources I looked at. https://en.wikipedia.org/wiki/User_agent

bruth commented 9 years ago

My gut tells me this is the not the place to put it since it feels more like an API version rather than a server version. That being said, how do you want to use this.

gracebrownecodes commented 9 years ago

Basically, I want to use it for debugging purposes and provenance, not to actually negotiate for API version or anything. Where do you think we should put it, in that case?

gracebrownecodes commented 9 years ago

BTW, this seems to be a huge debate I've stumbled onto:

http://www.troyhunt.com/2014/02/your-api-versioning-is-wrong-which-is.html https://www.mnot.net/blog/2011/10/25/web_api_versioning_smackdown

gracebrownecodes commented 9 years ago

In addition to exposing the data model version being exposed (work in #4, #5, and #6), I think the service version should be exposed as well, since that could alter the output.

gracebrownecodes commented 9 years ago

Working to include this in the output of the DDL generator. See chop-dbhi/data-models-service#9