11772 api terms of access #11893
Merged
11772 api terms of access #11893
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
github-actions
bot
added
the
FY26 Sprint 5
...java/edu/harvard/iq/dataverse/engine/command/impl/UpdateDatasetTermsOfAccessCommandTest.java
Outdated
Show resolved
Hide resolved
...java/edu/harvard/iq/dataverse/engine/command/impl/UpdateDatasetTermsOfAccessCommandTest.java
Outdated
Show resolved
Hide resolved
This comment has been minimized.
This comment has been minimized.
…ataverse into 11772-api-terms-of-access
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
stevenwinship
approved these changes
Oct 22, 2025
github-project-automation
bot
moved this from In Review 🔎
to Ready for QA ⏩
in IQSS Dataverse Project
ofahimIQSS
reviewed
Oct 24, 2025
This comment has been minimized.
This comment has been minimized.
1 similar comment
|
📦 Pushed preview images as 🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name. |
Contributor
|
looks good to me - merging |
github-project-automation
bot
moved this from QA ✅
to Merged 🚀
in IQSS Dataverse Project
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:
Adds an api to allow the user to update the terms of access for restricted files of a given dataset
Which issue(s) this PR closes:
Special notes for your reviewer:
The json parser creates a terms of use and access object that only includes terms of access items. In the command the dataset's existing license and terms of use are merged with the updated access items.
Suggestions on how to test this:
The api endpoint is: curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X PUT "https://demo.dataverse.org/api/datasets/3/access" -H "Content-type:application/json" --upload-file access.json
where access.json would look like this:
{
"customTermsOfAccess": {
"fileAccessRequest": true,
"termsOfAccess": "Your terms of access for restricted files",
"dataAccessPlace": "Your data access place",
"originalArchive": "Your original archive",
"availabilityStatus": "Your availability status",
"contactForAccess": "Your contact for access",
"sizeOfCollection": "Your size of collection",
"studyCompletion": "Your study completion"
}
}
make sure that the custom terms of use and/or license of the dataset are left unchanged.
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?: included
Additional documentation: added to native api docs