feat: let APIs return more info about role assignments#11920
Open
vera wants to merge 5 commits intoIQSS:developfrom
Open
feat: let APIs return more info about role assignments#11920vera wants to merge 5 commits intoIQSS:developfrom
vera wants to merge 5 commits intoIQSS:developfrom
Conversation
Contributor
|
@vera Please address the conflicts |
# Conflicts: # src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinter.java
Contributor
Author
Done! |
vera
added a commit
to nfdi4health/dataverse
that referenced
this pull request
Dec 12, 2025
vera
added a commit
to nfdi4health/dataverse
that referenced
this pull request
Jan 29, 2026
stevenwinship
approved these changes
Mar 10, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 updates all API endpoints that return information about role assignments (such as
/api/dataverses/$ID/assignmentsand/api/datasets/$ID/assignments) to include additional fields in their JSON responses:assigneeName,roleDescription,definitionPointName,definitionPointType, anddefinitionPointGlobalId(if available).We use this in our custom UI to display the list of assigned roles, similar to this Dataverse UI page:
The extended API responses should also be helpful for the SPA.
Which issue(s) this PR closes:
Not aware of any issue
Special notes for your reviewer:
/
Suggestions on how to test this:
Use API that returns information about role assignments, e.g.
curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" "localhost:8080/api/dataverses/root/assignments", and see the extended JSON response.Example response for a dataset (corresponds to UI screenshot above):
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've included a release note
Additional documentation:
/
cc @johannes-darms