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

Service-info per version of API or per server that implements APIs? #70

Open
denis-yuen opened this issue Sep 21, 2021 · 2 comments
Open

Comments

@denis-yuen
Copy link

Does service-info have any recommendations as to whether it should be implemented one per server or one per API version?

For example, dockstore.org implements https://dockstore.org/api/ga4gh/trs/v2/service-info
If theoretically we have https://dockstore.org/api/ga4gh/trs/v3/service-info and
https://dockstore.org/api/ga4gh/trs/v4/service-info going forward, we would have three service-info endpoints, once per version.

Would it make sense to have only one service-info endpoint that tells us which version of the API is available or is that out of scope for this standard?

@denis-yuen
Copy link
Author

Also see discussion at ga4gh/tool-registry-service-schemas#202

@mcupak
Copy link
Contributor

mcupak commented Sep 22, 2021

@denis-yuen That's a great question. The idea of supporting multiple versions of the same standard natively came up when we were designing this, but we weren't sure if anyone would actually use it, so we decided to defer this until we have real-life use cases, and treat different versions as separate services.

So for now, I'd recommend going with the one per version setup, since the metadata would likely differ (e.g. version, type/version, createdAt/updatedAt etc.). You could additionally set up a Service Registry to list these different versions for discovery purposes, but there's no functionality there to group them or say it's the same standard.

If this is a common scenario you've seen, we'd be happy to work with you on something better for a newer version of Service Info and/or Service Registry APIs.

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

No branches or pull requests

2 participants