Skip to content

Dataset compareSummary API: version summary should show tags changes #11663

@ChengShi-1

Description

@ChengShi-1

What steps does it take to reproduce the issue?
For Categories,

  1. create a dataset
  2. publish the dataset
  3. upload a file
  4. publish
  5. add a category to the file

No file metadata change from the api result in draft version (the change shows up after published sometimes)

For Tabular Tags,
changes in Tabular Tags wouldn't be reflected on any versions summary or versions comparison.

  1. create a dataset
  2. publish the dataset
  3. upload a tab file
  4. add tabular tags

No file metadata change in the api result(it wouldn't show up after published)

  • When does this issue occur?
    No details and summary appear

API should show files "changedFileMetaData": 1, but it shows 0
http://localhost:8000/api/v1/datasets/:persistentId/versions/compareSummary?persistentId=doi:10.5072/FK2/KWQX9V

{
    "status": "OK",
    "data": [
        {
            "id": 20,
            "versionNumber": "DRAFT",
            "summary": {
                "files": {
                    "added": 0,
                    "removed": 0,
                    "replaced": 0,
                    "changedFileMetaData": 0,
                    "changedVariableMetadata": 0
                },
                "termsAccessChanged": false
            },
            "contributors": "Dataverse Admin",
            "publishedOn": ""
        },
        {
            "id": 19,
            "versionNumber": "2.0",
            "summary": {
                "files": {
                    "added": 1,
                    "removed": 0,
                    "replaced": 0,
                    "changedFileMetaData": 0,
                    "changedVariableMetadata": 0
                },
                "termsAccessChanged": false
            },
            "contributors": "Dataverse Admin",
            "publishedOn": "2025-07-21"
        },
        {
            "id": 18,
            "versionNumber": "1.0",
            "summary": "firstPublished",
            "contributors": "Dataverse Admin",
            "publishedOn": "2025-07-21"
        }
    ]
}

Also
http://localhost:8000/api/v1/datasets/:persistentId/versions/2.0/compare/:draft?persistentId=doi:10.5072/FK2/KWQX9V&includeDeaccessioned=true

{
    "status": "OK",
    "data": {
        "oldVersion": {
            "versionNumber": "2.0",
            "versionState": "RELEASED",
            "lastUpdatedDate": "2025-07-21T18:16:43Z"
        },
        "newVersion": {
            "versionNumber": "DRAFT",
            "versionState": "DRAFT",
            "lastUpdatedDate": "2025-07-21T18:17:08Z"
        }
    }
}
  • Which page(s) does it occurs on?
    Dataset Page

  • What happens?
    No result for tags' changes in following api

  • compareSummary?
  • versions/2.0/compare/:draft?
  • To whom does it occur (all users, curators, superusers)?
    JSF and API users

  • What did you expect to happen?
    show file metadata changed

Screenshots:
JSF screenshots
Image
Image

No matter the issue, screenshots are always welcome.

To add a screenshot, please use one of the following formats and/or methods described here:

Are you thinking about creating a pull request for this issue?
Help is always welcome, is this bug something you or your organization plan to fix?

Metadata

Metadata

Assignees

No one assigned

    Labels

    FY26 Sprint 4FY26 Sprint 4 (2025-08-13 - 2025-08-27)FY26 Sprint 5FY26 Sprint 5 (2025-08-27 - 2025-09-10)FY26 Sprint 6FY26 Sprint 6 (2025-09-10 - 2025-09-24)FY26 Sprint 7FY26 Sprint 7 (2025-09-24 - 2025-10-08)GREI Re-archIssues related to the GREI Dataverse rearchitectureOriginal size: 10SPAThese changes are required for the Dataverse SPASize: 10A percentage of a sprint. 7 hours.Status: Waiting for Related Issues/PRsThis issue depends upon the completion of one or more issues/PRsType: Buga defect

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions