Skip to content

WIP: Versioning the API - #553

Open
harrisj wants to merge 3 commits into
masterfrom
api-versioning
Open

WIP: Versioning the API#553
harrisj wants to merge 3 commits into
masterfrom
api-versioning

Conversation

@harrisj

@harrisj harrisj commented Jun 12, 2017

Copy link
Copy Markdown

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

harrisj commented Jun 12, 2017

Copy link
Copy Markdown
Author

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

@cacraig

cacraig commented Jun 14, 2017

Copy link
Copy Markdown
Contributor

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

@harrisj

harrisj commented Jun 14, 2017

Copy link
Copy Markdown
Author

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

harrisj commented Jul 3, 2017

Copy link
Copy Markdown
Author

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