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

WIP: Versioning the API #553

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

WIP: Versioning the API #553

wants to merge 3 commits into from

Conversation

harrisj
Copy link
Contributor

@harrisj harrisj commented Jun 12, 2017

Fixes #140

The idea would be to move stuff into specific directories and either import from previous versions (base implmentations) or duplicate code for when an endpoint is changed from one version to the next.

@harrisj
Copy link
Contributor Author

harrisj commented Jun 12, 2017

@cacraig: I haven't finished work on this (would want to try out with a v1 API, but how does this look generally?

@cacraig
Copy link
Contributor

cacraig commented Jun 14, 2017

This looks good to me @harrisj - Versioning will be important moving forward. How do we want to name the routes? /beta/... or /v1/.... ?

@harrisj
Copy link
Contributor Author

harrisj commented Jun 14, 2017

I was thinking we would keep the beta ones without a version to not break the CDE for now, but would try to move to /v1. Then we'd kill the beta version Two things:

  1. Should we wait until we remove some endpoints like TableFamily ones first before we attempt this?
  2. I'm not sure if it's better to copy endpoints to the new version or import them. It seems like we'd also need to have a versioned Swagger to test old and new versions work

@harrisj
Copy link
Contributor Author

harrisj commented Jul 3, 2017

So I added some documentation to the README about this. Not sure if you all still like this approach. I'm thinking of disabling CodeClimate since this will mean more duplication

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

Successfully merging this pull request may close these issues.

3 participants