ohsu-comp-bio / py-tes

Python SDK for the GA4GH Task Execution API
https://py-tes.readthedocs.io/
MIT License
5 stars 10 forks source link

Client uses non-standard server URL #40

Open uniqueg opened 1 year ago

uniqueg commented 1 year ago

According to TES v1.0 and v1.1, the TES API should be hosted at /ga4gh/tes/v1:

servers:
- url: /ga4gh/tes/v1 

Currently, py-tes adds just /v1 as a suffix to the TES URL, and before the API paths /tasks and /service-info (compare #39).

In my opinion, py-tes should add /ga4gh/tes/v1 by default. But for greater (and backwards) compatibility, the TES URL suffix should perhaps be configurable.

uniqueg commented 1 year ago

@kellrott:

I see three main options to address this:

Please let me know what you think.

kellrott commented 1 year ago

I'm kind of in favor of doing some amount of automatic work for the user. For a true lightweight implementation, someone could use https://pypi.org/project/pydantic-tes/ So maybe py-tes should offer a little bit more 'easy of use' for softening issues between implementations

uniqueg commented 1 year ago

Got it! Will go with the last option then. It's also my favorite. And I guess that would also answer the question in #39.

Might be good to add this as an issue to Funnel. I have also created one in TESK: https://github.com/elixir-cloud-aai/tesk-api/issues/48