feat: return list of collections of datasets in search API #11558
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ofahimIQSS
moved this from Ready for Triage
to Ready for Review ⏩
in IQSS Dataverse Project
cmbz
added
FY25 Sprint 25
Contributor
|
Please resolve the conflicts. |
stevenwinship
moved this from Ready for Review ⏩
to In Review 🔎
in IQSS Dataverse Project
stevenwinship
moved this from In Review 🔎
to Ready for Review ⏩
in IQSS Dataverse Project
stevenwinship
added
the
Status: Needs Input
stevenwinship
moved this from Ready for Review ⏩
to In Review 🔎
in IQSS Dataverse Project
# Conflicts: # doc/sphinx-guides/source/api/search.rst # src/main/java/edu/harvard/iq/dataverse/api/Search.java # src/main/java/edu/harvard/iq/dataverse/search/SearchIncludeFragment.java # src/main/java/edu/harvard/iq/dataverse/search/SolrSearchServiceBean.java
Contributor
Author
|
@stevenwinship the conflicts have been resolved. |
pdurbin
removed
the
Status: Needs Input
Contributor
|
There is one test failing testShowCollections – edu.harvard.iq.dataverse.api.SearchIT 1 expectation failed. java.lang.AssertionError: |
Contributor
Author
|
It seems like the test was flaky because the order of the collections being returned wasn't fixed. It should work now. |
stevenwinship
approved these changes
Aug 6, 2025
github-project-automation
bot
moved this from In Review 🔎
to Ready for QA ⏩
in IQSS Dataverse Project
Contributor
|
tests are passing - merging PR |
github-project-automation
bot
moved this from QA ✅
to Merged 🚀
in IQSS Dataverse Project
pdurbin
added a commit
that referenced
this pull request
Sep 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR adds a
show_collectionsparameter for dataset results to the search API.When the parameter is set, each result includes a
collectionsarray showing the dataset’s parent and linked collections. Each entry includesid,name, andalias, for example:Which issue(s) this PR closes:
Not aware of any issue.
Special notes for your reviewer:
/
Suggestions on how to test this:
Create at least one dataset, run searches via the search API with and without
show_collections=trueto see that if the param is set, the list of collections is returned, otherwise the search response is unchanged.I've added a test:
mvn test -Dtest="SearchIT#testShowCollections"Does this PR introduce a user interface change? If mockups are available, please link/include them here:
/
Is there a release notes update needed for this change?:
I will add a short release note
Additional documentation:
In our custom UI, we want to display the list of collections of each search result, which is why we would like this feature. See this screenshot: