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

base path problem with TRS URIs #220

Open
denis-yuen opened this issue Jun 14, 2022 · 3 comments
Open

base path problem with TRS URIs #220

denis-yuen opened this issue Jun 14, 2022 · 3 comments
Labels
Milestone

Comments

@denis-yuen
Copy link
Member

denis-yuen commented Jun 14, 2022

Proposal to break this discussion off from the PR discussion in #202

This problem focuses on the issue that TRS URIs as proposed do not include a base path. Without a base path, you can tell which domain a TRS URI is referring to, but not the exact endpoints.. For example trs://<server>/<id>/<version_id> tells you to go to server but not specifically where. dockstore.org hosts various versions (2.0 beta, 2.0 final, v1) TRS endpoints under api while workflowhub.eu serves it at the root.

From rough notes:

  • @patmagee noted that not resolving this will make TRS URIs much less useful
  • @ianfore (?) noted that https://github.com/ga4gh/ga4gh-registry could be a possible road forward, however, server is down and future of project is unknown
  • discussion on what do to for multi-tenant systems

┆Issue is synchronized with this Jira Story
┆Project Name: Zzz-ARCHIVE GA4GH tool-registry-service
┆Issue Number: TRS-56

@denis-yuen denis-yuen added this to the v2.0.1 milestone Jun 14, 2022
@denis-yuen
Copy link
Member Author

Relevant comment chain at #202 (comment)

@denis-yuen
Copy link
Member Author

Brian: service info discussion, not sure if we established clear convention at particular paths on the host.
Would be a good for GA4GH to use something like the registry or a convention that could allow for self-describing how to interact with a server
Alex: we need DRS and TRS participants to chat, both APIs have this problem. service-info is an issue because its nested inside the API, so by the time you have it ...
Brian: can there be like a root service-info? or maybe the path of least resistance is to use the service registry?

David: for DRS, it seems to specify how to get from URI to URL, handwaves over which version of DRS you want to talk to. Example documentation seems to assume DRS is hosted on the root (can the hostname include a path?)
Brian: may have been implicit assumption that all DRS servers do have this assumption that it is on the root
Jose: can we urlencode the prefix/path into the hostname?
Alex: may not be a huge deal (there may be a workaround)
Discussion on API versioning, what obligations/assumptions should there be about what versions of the API are available

Brian: Someone may need to do a PR to TRS or DRS do demonstrate how to work with URIs that include paths. Can include path, but probably shouldn't encode versions (may break in the future). Schema may change in the future, but the URI should be stable over time

Table this for a week depending on whether we have a volunteer to look into this, otherwise should not be considered blocker for plenary

@denis-yuen
Copy link
Member Author

Yash: discussion on endpoints in GA4GH registry
would be useful to take a look, potentially today
Brian: Does it make available a list of all the servers and a list of paths on those servers where services are available, Denis also interested. Current process seems to be via email.

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

No branches or pull requests

1 participant