This pull request has been designated for reprocessing. Please check back in a few minutes.

Home » Oreps » Dataverse » All Pull Requests » #12711
iqss/dataverse
Open source research data repository software
Watch
1
Commit Activity
Pull Requests
Directory Browser
Velocity History
Releases

add "version" query parameter to file citation API #12711

Compare code on GitHub
Open
pdurbin opened 5:02pm on September 15, 2026 wants to merge 1 commit into iqss/dataverse develop from
12512-file-citation-version
This work implements File Citation in Formats API extension: include a version parameter (open)

Issue #11733 added support for retrieving file citations in multiple formats, similar to the existing dataset-level Get Citation In Other Formats API. However, file citations also need to clearly identify the dataset/file version being cited. Now, without a version parameter, the API always return latest version of citation. Similar to Get Citation in Native API, we need to include a version param

pdurbin
iqss/dataverse
12512-file-citation-version
Diff Delta:
0
About 29 Diff Delta/hour
Classified as:  Feature Add

pdurbin's Description of Work #12512 File Citation in Formats API extension: include a version parameter

What this PR does / why we need it:

In the SPA, we want to be able to specify the dataset version when downloading a file citation:

This pull request is the backend change needed to extend the API. After it is merged, we can add it to js-dataverse:

Which issue(s) this PR closes:


  • Closes #12512

Special notes for your reviewer:

I used ChatGPT/Codex to write the initial code. πŸ€– Then I tweaked it to my liking.

Suggestions on how to test this:

Create multiple versions of a dataset. Try passing the version parameter.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No. API only.

Is there a release notes update needed for this change?:

Included.

Additional documentation:

None.

5 total changed files
(1 file ignored)
Loading changes...
Loading changes...
You’ve completed the full review pass
Reviewer: 1. Additional work: 0
GitClear uses cookies to ensure you get the best experience on our website. Learn more about our cookie policy