Stream: IG creation
Topic: Versioning an operation's URL
Bob Dolin (Feb 24 2022 at 00:11):
We are developing a set of FHIR Genomics operations, and I was asked if we can support versioning in the URL (e.g. current version might look like this 'GET .../$find-subject-variants?subject=HG00403&ranges=NC_000007.14:140713327-140924929' whereas someone can call an earlier version, like this 'GET .../v1/$find-subject-variants?subject=HG00403&ranges=NC_000007.14:140713327-140924929'). Is there any guidance on this?
Grahame Grieve (Feb 24 2022 at 00:39):
earlier version of what?
Kevin Power (Feb 24 2022 at 14:37):
@Bob Dolin - I think the answer is that the 'version' is fixed by the release of the IG. Meaning there will be the STU2 version of the operation, the STU3 version, etc ...
Bob Dolin (Feb 24 2022 at 14:55):
Thanks @Kevin Power @Grahame Grieve . So, let's say we have a version of the $find-subject-variants operation in STU2, and then we ballot a new version in STU3. If someone wants to support both the STU2 and STU3 versions, should we provide guidance around the URLs? For instance, to call the STU3 version, just use '.../$find-subject-variants' and to call the STU2 version, use '.../STU2/$find-subject-variants'?
Grahame Grieve (Feb 24 2022 at 19:20):
so an earlier version of the operation?
Grahame Grieve (Feb 24 2022 at 19:21):
there's no formal way to do that. The best option is that the definition is forwards compatible. If it's not, then it's really a different operation - $find-subject-variants-2 or something
Grahame Grieve (Feb 24 2022 at 19:21):
/STU2/$find.. implies a whole different end-point with resources all available on /STU2.
Last updated: Apr 12 2022 at 19:14 UTC
