Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 21 commits into
base: develop
Choose a base branch
from

Conversation

sekmiller
Copy link
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

coveralls commented Feb 14, 2025

Coverage Status

coverage: 22.77% (+0.03%) from 22.741%
when pulling 6538731 on 11188-version-difference-summary
into 4b3afe3 on develop.

This comment has been minimized.

This comment has been minimized.

@sekmiller sekmiller removed their assignment Feb 14, 2025

This comment has been minimized.

Copy link

📦 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.

@stevenwinship stevenwinship self-assigned this Feb 21, 2025
<h:outputText rendered="#{blockNote.added > 0}" value="#{blockNote.added} #{bundle['file.dataFilesTab.versions.added']}" />
<h:outputText rendered="#{(blockNote.added) > 0 and (blockNote.changed + blockNote.deleted) > 0}" value=", " />
<h:outputText rendered="#{(blockNote.deleted) > 0}" value="#{blockNote.deleted} #{bundle['file.dataFilesTab.versions.removed']}" />
<h:outputText rendered="#{(blockNote.changed) > 0 and (blockNote.changed) > 0}" value=", " />
Copy link
Contributor

Choose a reason for hiding this comment

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

should this be
(blockNote.deleted) > 0 and (blockNote.changed)

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) GREI Re-arch Issues related to the GREI Dataverse rearchitecture 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: In Review 🔎
Development

Successfully merging this pull request may close these issues.

Dataset Versions API: add version differences
5 participants