Skip to content

11188 API to get list of dataset versions with summary of differences#11247

Merged
ofahimIQSS merged 31 commits intodevelopfrom
11188-version-difference-summary
Feb 27, 2025
Merged

11188 API to get list of dataset versions with summary of differences#11247
ofahimIQSS merged 31 commits intodevelopfrom
11188-version-difference-summary

Conversation

@sekmiller
Copy link
Copy Markdown
Contributor

What this PR does / why we need it: For the SPA we need an api that returns a list of Dataset Versions for the Versions Tab. The versions tab also shows a summary of differences between consecutive versions when available so that is returned as part of the response.

Which issue(s) this PR closes:

Special notes for your reviewer: As per request of Ellen, the Dataset Field type names and Metadata block names are in display name format. The DatasetsIT#testCompareDatasetVersionsAPI is failing - not sure why it shouldn't have been changed in my branch, but the order of two metadata field is reversed.

Suggestions on how to test this: Try the api for a dataset with multiple versions and see that the response gives the info required to load into the versions tab of the dataset page. If there's a draft version use tokens with and without view unpublished permissions.

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

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

Additional documentation: added to the native api doc

@sekmiller sekmiller self-assigned this Feb 12, 2025
@sekmiller sekmiller added Size: 3 A percentage of a sprint. 2.1 hours. FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) labels Feb 12, 2025
@g-saracca g-saracca added GREI Re-arch Issues related to the GREI Dataverse rearchitecture SPA These changes are required for the Dataverse SPA SPA.Q1.2 Dataset Page: Versions Tab labels Feb 12, 2025
@cmbz cmbz added the FY25 Sprint 17 FY25 Sprint 17 (2025-02-12 - 2025-02-26) label Feb 12, 2025
@coveralls
Copy link
Copy Markdown

coveralls commented Feb 14, 2025

Coverage Status

coverage: 22.75% (+0.03%) from 22.721%
when pulling b38d9ca on 11188-version-difference-summary
into 35546cc on develop.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-project-automation github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Feb 25, 2025
@stevenwinship stevenwinship removed their assignment Feb 25, 2025
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@g-saracca
Copy link
Copy Markdown
Contributor

Endpoint working correctly, already using it and testing it in this issue I am working on.

@github-actions

This comment has been minimized.

@cmbz cmbz added this to the 6.6 milestone Feb 26, 2025
@ofahimIQSS ofahimIQSS self-assigned this Feb 26, 2025
@ofahimIQSS ofahimIQSS moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Feb 26, 2025
@github-actions

This comment has been minimized.

@cmbz cmbz added the FY25 Sprint 18 FY25 Sprint 18 (2025-02-26 - 2025-03-12) label Feb 27, 2025
@github-actions
Copy link
Copy Markdown

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11188-version-difference-summary
ghcr.io/gdcc/configbaker:11188-version-difference-summary

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

@ofahimIQSS
Copy link
Copy Markdown
Contributor

PR looks good - merging.

@ofahimIQSS ofahimIQSS merged commit 66269e2 into develop Feb 27, 2025
23 checks passed
@github-project-automation github-project-automation bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Feb 27, 2025
@ofahimIQSS ofahimIQSS deleted the 11188-version-difference-summary branch February 27, 2025 19:49
@ofahimIQSS ofahimIQSS removed their assignment Feb 27, 2025
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) FY25 Sprint 17 FY25 Sprint 17 (2025-02-12 - 2025-02-26) FY25 Sprint 18 FY25 Sprint 18 (2025-02-26 - 2025-03-12) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 3 Size: 3 A percentage of a sprint. 2.1 hours. SPA.Q1.2 Dataset Page: Versions Tab SPA These changes are required for the Dataverse SPA

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

Dataset Versions API: add version differences

8 participants