Skip to content

Conversation

@vera
Copy link

@vera vera commented Nov 27, 2025

What this PR does / why we need it:

This PR adds code for using the "List Versions of a Dataset" API.

Which issue(s) this PR closes:

I'm not aware of an open issue.

Related Dataverse PRs:

Special notes for your reviewer:

/

Suggestions on how to test this:

I've added tests and docs on how to use.

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

Yes

Additional documentation:

/

@vera vera marked this pull request as ready for review November 27, 2025 15:41
@pdurbin pdurbin moved this to Ready for Triage in IQSS Dataverse Project Dec 1, 2025
@scolapasta scolapasta moved this from Ready for Triage to Ready for Review ⏩ in IQSS Dataverse Project Dec 2, 2025
@cmbz cmbz added FY26 Sprint 11 FY26 Sprint 11 (2025-11-20 - 2025-12-03) FY26 Sprint 12 FY26 Sprint 12 (2025-12-03 - 2025-12-17) labels Dec 3, 2025
Copy link
Contributor

@ekraffmiller ekraffmiller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @vera, thanks for your PR. We don't currently need this use case in our SPA, because we use GetDatasetVersionsSummaries, and GetDatasetVersionDiff to display a list of Dataset versions. But since it is available on the Dataverse API I think it's ok to add. The only caveat I have is to not return the list of files, for performance reasons.

- **limit**: (number) Limit for pagination.
- **offset**: (number) Offset for pagination.
- **excludeMetadataBlocks**: (boolean) Exclude metadata blocks (default: false).
- **excludesFiles**: (boolean) Exclude files (default: true).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think returning the complete list of files in the response could be a problem - some of our datasets have several thousand files. We have another use case, GetDatasetFiles, which returns the files with pagination. My suggestion is to remove files from the response, and use the other use case to get the files with pagination.

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

Labels

FY26 Sprint 11 FY26 Sprint 11 (2025-11-20 - 2025-12-03) FY26 Sprint 12 FY26 Sprint 12 (2025-12-03 - 2025-12-17)

Projects

Status: Ready for Review ⏩

Development

Successfully merging this pull request may close these issues.

3 participants