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

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

Open
pdurbin opened 5:02pm on September 15, 2026 wants to merge 1 commit into iqss/dataverse develop from
12512-file-citation-version

Pull Request Overview

  • Opened on September 15, 2026
  • Status Open
  • Commit count 1 with first commit September 15, 2026

Total Delta

0 Total Diff Delta

Open Days

Open 4 weekdays

Test Delta

0 Diff Delta in Test Files
Breakdown by Phase

How long has this pull request spent in each phase of its lifecycle?

Fraction of total time Business days Phase
N/A 53.5 days Issue creation to work beginning
 
0.0 days Authoring 1 commit before pull request opened for review
 
0.0 days Awaiting first review
 
3.2 days Revising work with 0 commits in response to 0 reviews that left 4 comments

Total time for pull request still awaiting merge: 3.2 business days

Author avatar

add "version" query parameter to file citation API

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.

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

Comments Threads Pending Resolution

Resolved Comment Threads

No resolved comments have been left on this PR.