Skip to content

Conversation

sekmiller
Copy link
Contributor

@sekmiller sekmiller commented Oct 9, 2025

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

@github-actions github-actions bot added the FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) label Oct 9, 2025
@github-actions github-actions bot added FY26 Sprint 6 FY26 Sprint 6 (2025-09-10 - 2025-09-24) FY26 Sprint 7 FY26 Sprint 7 (2025-09-24 - 2025-10-08) FY26 Sprint 8 FY26 Sprint 8 (2025-10-08 - 2025-10-22) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 20 Size: 10 A percentage of a sprint. 7 hours. SPA These changes are required for the Dataverse SPA SPA.Q3.2025.3 Dataset Page: Edit Terms Type: Feature a feature request labels Oct 9, 2025
@sekmiller sekmiller added this to the 6.9 milestone Oct 9, 2025
@sekmiller sekmiller moved this to Ready for Review ⏩ in IQSS Dataverse Project Oct 9, 2025
@coveralls
Copy link

coveralls commented Oct 9, 2025

Coverage Status

coverage: 23.549% (+0.008%) from 23.541%
when pulling 1252f38 on 11772-api-terms-of-access
into 89813b7 on develop.

This comment has been minimized.

1 similar comment

This comment has been minimized.

Copy link

github-actions bot commented Oct 9, 2025

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11772-api-terms-of-access
ghcr.io/gdcc/configbaker:11772-api-terms-of-access

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) FY26 Sprint 6 FY26 Sprint 6 (2025-09-10 - 2025-09-24) FY26 Sprint 7 FY26 Sprint 7 (2025-09-24 - 2025-10-08) FY26 Sprint 8 FY26 Sprint 8 (2025-10-08 - 2025-10-22) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 20 Size: 10 A percentage of a sprint. 7 hours. SPA.Q3.2025.3 Dataset Page: Edit Terms SPA These changes are required for the Dataverse SPA Type: Feature a feature request

Projects

Status: Ready for Review ⏩

Development

Successfully merging this pull request may close these issues.

API: Restricted Files & Terms of Access in the dataset

2 participants