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

Add API endpoint for comparing Dataset Versions #10945

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

Conversation

stevenwinship
Copy link
Contributor

@stevenwinship stevenwinship commented Oct 21, 2024

What this PR does / why we need it: Need an API endpoint that will compare two dataset versions and return a list of differences between the versions. This is needed to support the SPA Dataset Page

Which issue(s) this PR closes: #10888

Special notes for your reviewer:

Suggestions on how to test this: See IT and Unit tests

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

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

Additional documentation:
https://dataverse-guide--10945.org.readthedocs.build/en/10945/

@stevenwinship stevenwinship self-assigned this Oct 21, 2024
@stevenwinship stevenwinship added Feature: API GREI Re-arch Issues related to the GREI Dataverse rearchitecture FY25 Sprint 8 FY25 Sprint 8 (2024-10-09 - 2024-10-23) Size: 30 A percentage of a sprint. 21 hours. (formerly size:33) SPA.Q4.1 Collection Page: All Filtering Options SPA These changes are required for the Dataverse SPA Type: Feature a feature request and removed SPA.Q4.1 Collection Page: All Filtering Options labels Oct 21, 2024
@coveralls
Copy link

coveralls commented Oct 21, 2024

Coverage Status

coverage: 21.41% (+0.5%) from 20.868%
when pulling d957f60 on 10888-add-api-for-comparing-dataset-versions
into d039a10 on develop.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

@cmbz cmbz added the FY25 Sprint 9 FY25 Sprint 9 (2024-10-23 - 2024-11-06) label Oct 23, 2024
@ekraffmiller
Copy link
Contributor

HI @stevenwinship I tried the latest version of the API, it looks good, just needs a few small changes:

  • oldVersion: use 'lastUpdatedDate' rather than 'createdDate'
  • files: (added, removed or replaced): include tags (categories) and filePath (directoryLabel)

Copy link

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:10888-add-api-for-comparing-dataset-versions
ghcr.io/gdcc/configbaker:10888-add-api-for-comparing-dataset-versions

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

@stevenwinship
Copy link
Contributor Author

HI @stevenwinship I tried the latest version of the API, it looks good, just needs a few small changes:

  • oldVersion: use 'lastUpdatedDate' rather than 'createdDate'
  • files: (added, removed or replaced): include tags (categories) and filePath (directoryLabel)

Fixed

@stevenwinship stevenwinship removed their assignment Oct 24, 2024
@stevenwinship stevenwinship added Original size: 30 Size: 3 A percentage of a sprint. 2.1 hours. and removed Size: 30 A percentage of a sprint. 21 hours. (formerly size:33) labels Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: API FY25 Sprint 8 FY25 Sprint 8 (2024-10-09 - 2024-10-23) FY25 Sprint 9 FY25 Sprint 9 (2024-10-23 - 2024-11-06) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 30 Size: 3 A percentage of a sprint. 2.1 hours. SPA These changes are required for the Dataverse SPA Type: Feature a feature request
Projects
Status: Ready for Review ⏩
Development

Successfully merging this pull request may close these issues.

Feature Request: Add API endpoint for comparing Dataset Versions
4 participants