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.

Sign up for GitHub

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

Jump to bottom

API versioning #9

Open
2 tasks
3Hren opened this issue Jun 19, 2017 · 0 comments
Open
2 tasks

API versioning #9

3Hren opened this issue Jun 19, 2017 · 0 comments
Labels
P: medium T: docs T: feature V: minor

Comments

@3Hren
Copy link
Owner

3Hren commented Jun 19, 2017 •
edited
Loading

Since we're not a library it is required to notify our clients about API change.

For example a monitoring server API provides /metrics method, which returns a JSON. To be able to keep the proxy backward compatible we can add /vN prefix and it becomes /v1/metrics.

Moreover we should mention how we treat semantic versioning. Strictly, we should bump major version when:

  • The config changes in backward-incompatible manner.
  • We break URIs.

So, the tasks are:

  • Wrap API paths with version prefix.
  • Update README.md.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
P: medium T: docs T: feature V: minor
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@3Hren