Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include (Sub-)version info via an endpoint #384

Open
ChrisMalewski opened this issue May 24, 2017 · 1 comment
Open

Include (Sub-)version info via an endpoint #384

ChrisMalewski opened this issue May 24, 2017 · 1 comment
Assignees
Milestone

Comments

@ChrisMalewski
Copy link

A version hint (v1) is included in the url.

We should include the version (and subversion) info also in a service response e.g. root endpoint.

This corresponds directly with this issue issue, since helgoland detects the version implicit and not explicit.

@ridoo
Copy link
Member

ridoo commented May 31, 2017

As we agreed on the Web API have to stay backwards compatible. So we will omit the v1 part of the URL from 2.x versions. Having v1 in the URL might create wrong assumptions and leads to confusion about API incompatibilities.

To put it short:

Older clients shall always be able to consume any version of the Series API.

Anyway, what you are suggesting we already discussed recently. We came up with adding a version string in the HTTP response header -- I mean no version negotiation, just a custom info header, which will
help the client to find out. A client have to be smart enough to handle if a particular feature is supported or not.

Is it something you find helpful as well?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants