Skip to content

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

Open
pdurbin wants to merge 1 commit into
developfrom
12512-file-citation-version
Open

pdurbin wants to merge 1 commit into
developfrom
12512-file-citation-version

Conversation

@pdurbin

@pdurbin pdurbin commented Sep 15, 2026

Copy link
Copy Markdown
Member

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:

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.

@github-actions github-actions Bot added the FY26 Sprint 26 FY26 Sprint 26 (2026-06-17 - 2026-07-01) label Sep 15, 2026
@pdurbin pdurbin moved this to Ready for Review ⏩ in IQSS Dataverse Project Sep 15, 2026
@github-actions github-actions Bot added FY27 Sprint 1 FY27 Sprint 1 (2026-07-01 - 2026-07-15) FY27 Sprint 2 FY27 Sprint 2 (2026-07-15 - 2026-07-29) FY27 Sprint 3 FY27 Sprint 3 (2026-07-29 - 2026-08-12) FY27 Sprint 4 FY27 Sprint 4 (2026-08-12 - 2026-08-26) FY27 Sprint 5 FY27 Sprint 5 (2026-08-26 - 2026-09-09) FY27 Sprint 6 FY27 Sprint 6 (2026-09-09 - 2026-09-23) Original size: 10 Size: 10 A percentage of a sprint. 7 hours. SPA These changes are required for the Dataverse SPA labels Sep 15, 2026
@pdurbin pdurbin added this to the 6.13 milestone Sep 15, 2026
@sonarqubecloud

Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

@coveralls

Copy link
Copy Markdown

Coverage Status

Coverage is 25.409%12512-file-citation-version into develop. No base build found for develop.

@github-actions

Copy link
Copy Markdown

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:12512-file-citation-version
ghcr.io/gdcc/configbaker:12512-file-citation-version

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

@github-actions

Copy link
Copy Markdown

Test Results

406 tests   391 ✅  37m 50s ⏱️
 55 suites   15 💤
 55 files      0 ❌

Results for commit cc436b5.

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

Labels

FY26 Sprint 26 FY26 Sprint 26 (2026-06-17 - 2026-07-01) FY27 Sprint 1 FY27 Sprint 1 (2026-07-01 - 2026-07-15) FY27 Sprint 2 FY27 Sprint 2 (2026-07-15 - 2026-07-29) FY27 Sprint 3 FY27 Sprint 3 (2026-07-29 - 2026-08-12) FY27 Sprint 4 FY27 Sprint 4 (2026-08-12 - 2026-08-26) FY27 Sprint 5 FY27 Sprint 5 (2026-08-26 - 2026-09-09) FY27 Sprint 6 FY27 Sprint 6 (2026-09-09 - 2026-09-23) Original size: 10 Size: 10 A percentage of a sprint. 7 hours. SPA These changes are required for the Dataverse SPA

Projects

Status: Ready for Review ⏩

Development

Successfully merging this pull request may close these issues.

File Citation in Formats API extension: include a version parameter

2 participants