dataverse icon indicating copy to clipboard operation
dataverse copied to clipboard

Add API endpoint for comparing Dataset Versions

Open stevenwinship opened this issue 1 year ago • 8 comments

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: https://github.com/IQSS/dataverse/issues/10888

  • 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 avatar Oct 21 '24 15:10 stevenwinship

Coverage Status

coverage: 22.4% (+0.5%) from 21.856% when pulling 91fef44c0080a5c505a6e170489762d4982e4f43 on 10888-add-api-for-comparing-dataset-versions into e208eede135a96e2d0250448ffbb9ad38b3f7325 on develop.

coveralls avatar Oct 21 '24 15:10 coveralls

:package: 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

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

github-actions[bot] avatar Oct 21 '24 15:10 github-actions[bot]

:package: 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

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

github-actions[bot] avatar Oct 21 '24 20:10 github-actions[bot]

:package: 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

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

github-actions[bot] avatar Oct 22 '24 21:10 github-actions[bot]

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)

ekraffmiller avatar Oct 24 '24 13:10 ekraffmiller

:package: 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

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

github-actions[bot] avatar Oct 24 '24 15:10 github-actions[bot]

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 avatar Oct 24 '24 15:10 stevenwinship

There's potential for merge conflicts with this PR:

  • #10969

Right? 🤔

pdurbin avatar Oct 25 '24 20:10 pdurbin

There's potential for merge conflicts with this PR:

Right? 🤔

I think it's conflict-free. Maybe in IT tests. I will help if needed. Good job @stevenwinship by the way.

luddaniel avatar Oct 28 '24 09:10 luddaniel

:package: 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

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

github-actions[bot] avatar Nov 06 '24 16:11 github-actions[bot]

:package: 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

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

github-actions[bot] avatar Nov 06 '24 16:11 github-actions[bot]

:package: 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

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

github-actions[bot] avatar Nov 06 '24 16:11 github-actions[bot]

:package: 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

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

github-actions[bot] avatar Nov 14 '24 18:11 github-actions[bot]

:package: 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

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

github-actions[bot] avatar Nov 18 '24 17:11 github-actions[bot]

IT and unit test passed - merging PR

ofahimIQSS avatar Nov 19 '24 16:11 ofahimIQSS

@stevenwinship can you please resolve the branch conflicts. Thanks!

ofahimIQSS avatar Nov 19 '24 16:11 ofahimIQSS

:package: 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

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

github-actions[bot] avatar Nov 20 '24 18:11 github-actions[bot]

IT and Unit tests passing - Merging PR monitoring and Jenkins.

ofahimIQSS avatar Nov 22 '24 16:11 ofahimIQSS