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

Add semantic versioning to the REST URLs #48

Open
jeffhhk opened this issue Aug 4, 2021 · 1 comment
Open

Add semantic versioning to the REST URLs #48

jeffhhk opened this issue Aug 4, 2021 · 1 comment
Assignees
Labels
Post-September Relay Changes Post September 2021 Relay bug fixes / feature addition

Comments

@jeffhhk
Copy link
Contributor

jeffhhk commented Aug 4, 2021

Add a semantic versoning prefix to the KGE URLs, so that you can keep things running as you need to improve your system. So e.g.:

GET https://archive.translator.ncats.io/archive/yeast-sri-reference-kg-tsv/1.0/download

becomes:

GET https://archive.translator.ncats.io/v1/archive/yeast-sri-reference-kg-tsv/1.0/download

That way, when it is convenient to break with backward compatibility for the service calls necessary to drive your UI, it doesn't necessarily have to come at the cost of breaking programmatic consumers of KGE.

@RichardBruskiewich
Copy link
Collaborator

It's "simple" to apply at the architectural level: NGINX aliasing would redirect various semantic versioned API's to distinct docker containers running such variants. The hard part may be the management of the code base and docker-compose collection of containers to allow for this.

We can ponder this further once a relatively stable initial production release is finalized for the September 2021 relay. Maybe branding that release as the official V1 (web services backend) release, then moving future production iterations into a fresh release branch, may be feasible at that point.

@RichardBruskiewich RichardBruskiewich self-assigned this Sep 20, 2021
@RichardBruskiewich RichardBruskiewich added the Post-September Relay Changes Post September 2021 Relay bug fixes / feature addition label Sep 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Post-September Relay Changes Post September 2021 Relay bug fixes / feature addition
Projects
None yet
Development

No branches or pull requests

2 participants