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

feat: Identify datasets by their URI #1426

Merged
merged 5 commits into from
Sep 23, 2024
Merged

feat: Identify datasets by their URI #1426

merged 5 commits into from
Sep 23, 2024

Conversation

ddeboer
Copy link
Member

@ddeboer ddeboer commented Sep 17, 2024

Fix #1423

Terminology sources are no longer identifier by their distribution URI.
Keep BC by still allowing the distribution URI to be used when searching.
The sources query now returns the new source instead of distribution URIs.

BREAKING CHANGE: terminology sources are no longer identifier by their
distribution URI. Keep BC by still allowing the distribution URI to be
used when searching. However, the sources query now returns source
instead of distribution URIs.
* Consistently identify variants with hash (#) instead of slash (/).

BREAKING CHANGE: terminology sources are no longer identifier by their
distribution URI. Keep BC by still allowing the distribution URI to be
used when searching. However, the sources query now returns source
instead of distribution URIs.
Copy link
Contributor

@EnnoMeijers EnnoMeijers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me but we should ask the PO (Ruben) for explicite approval as it a quite a fundamental change.

@rschalkrce
Copy link
Contributor

As long as we continue both distribution and source ID for the time being it looks good to me as well. In the longer run we should communicate the move to dataset ID's first before phasing out distribution ID's. Just to be sure, this PR does not result in a breaking change, right?

@ddeboer
Copy link
Member Author

ddeboer commented Sep 19, 2024

Just to be sure, this PR does not result in a breaking change, right?

There’s no breaking change for clients when sending queries as they can continue to use the distribution URI as before.

However, there may be a breaking change for clients when reading the results, if they want to match the URIs from results with multiple terminology sources with the distribution URIs they used when sending the query. However, the results also contain each source’s name, so I’m hoping that’s not a serious break.

@ddeboer ddeboer changed the title feat: Identity datasets by their URI feat: Identify datasets by their URI Sep 19, 2024
@ddeboer ddeboer merged commit 5ce243e into master Sep 23, 2024
2 checks passed
@ddeboer ddeboer deleted the 1423-dataset-uri branch September 23, 2024 12:45
@ddeboer
Copy link
Member Author

ddeboer commented Sep 23, 2024

🎉 This PR is included in version 5.4.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@ddeboer
Copy link
Member Author

ddeboer commented Sep 23, 2024

🎉 This PR is included in version 9.16.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

Use dataset URI instead of distribution URI
3 participants