Skip to content

Notifications API fixes for In-App#11851

Merged
sekmiller merged 35 commits intodevelopfrom
11804-notifs-api-ext
Nov 25, 2025
Merged

Notifications API fixes for In-App#11851
sekmiller merged 35 commits intodevelopfrom
11804-notifs-api-ext

Conversation

@GPortas
Copy link
Contributor

@GPortas GPortas commented Sep 29, 2025

What this PR does / why we need it:

Endpoint: notifications/all

Enhancements:

  • When the query parameter inAppNotificationFormat=true is set:

    • Notifications of types:

      • REQUESTFILEACCESS
      • REQUESTEDFILEACCESS
      • GRANTFILEACCESS
      • REJECTFILEACCESS

    now return both the dataset display name and dataset persistent identifier.

Notifications of type DATASETMENTIONED now return a formatted JSON in the additionalInfo field when this field contains a valid persisted JSON string, instead of a raw JSON string.

Which issue(s) this PR closes:

Suggestions on how to test this:

  • Visual inspection of the new added properties, and related unit test cases
  • Test generating the updated notification types and test the endpoint for InApp notifications by calling:

curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/notifications/all?inAppNotificationFormat=true"
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?:
Yes, attached

@coveralls
Copy link

coveralls commented Sep 29, 2025

Coverage Status

coverage: 24.184% (+0.02%) from 24.165%
when pulling b8cca26 on 11804-notifs-api-ext
into 739052f on develop.

@github-actions

This comment has been minimized.

@GPortas GPortas marked this pull request as ready for review September 29, 2025 15:05
@GPortas GPortas moved this to Ready for Review ⏩ in IQSS Dataverse Project Sep 29, 2025
@github-actions

This comment has been minimized.

@GPortas GPortas added Size: 3 A percentage of a sprint. 2.1 hours. SPA These changes are required for the Dataverse SPA GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 3 SPA.Q3.2025.6 Account: Notifications labels Sep 29, 2025
@github-actions

This comment has been minimized.

1 similar comment
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@ekraffmiller
Copy link
Contributor

Hi @GPortas , I tested this with the frontend, and I found some issues in the response data.

For GRANTFILEACCESS and REJECTFILEACCESS
notifications, it's returning objectDeleted: true, rather than the datasetDisplayName and datasetPersistentId. For example for GRANTFILEACCESS, the notification coming from the API:


{

displayAsRead: true


id: 9


objectDeleted: true


sentTimestamp: "2025-10-03T00:23:32Z"


type: "GRANTFILEACCESS"

}


For REQUESTEDFILEACCESS, it's not returning the full datasetPersistentId.
For example it is returning:
datasetPersistentIdentifier: "FK2/1LPTK4"
when it should be:
datasetPersistentIdentifier: ”doi:10.5072/FK2/1LPTK4"




@GPortas GPortas self-assigned this Oct 8, 2025
@stevenwinship stevenwinship moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Nov 4, 2025
@github-project-automation github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Nov 4, 2025
@stevenwinship stevenwinship removed their assignment Nov 4, 2025
@cmbz cmbz added the FY26 Sprint 10 FY26 Sprint 10 (2025-11-05 - 2025-11-19) label Nov 5, 2025
@ekraffmiller ekraffmiller moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Nov 17, 2025
@ekraffmiller ekraffmiller self-assigned this Nov 17, 2025
@cmbz cmbz added the FY26 Sprint 11 FY26 Sprint 11 (2025-11-20 - 2025-12-03) label Nov 22, 2025
@sekmiller sekmiller assigned sekmiller and unassigned ekraffmiller Nov 24, 2025
@github-actions

This comment has been minimized.

Implements pagination and unread-only filter options to notifications/all endpoint
@github-actions

This comment has been minimized.

@github-actions
Copy link

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11804-notifs-api-ext
ghcr.io/gdcc/configbaker:11804-notifs-api-ext

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

@sekmiller sekmiller merged commit a862c90 into develop Nov 25, 2025
21 checks passed
@github-project-automation github-project-automation bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Nov 25, 2025
@sekmiller sekmiller deleted the 11804-notifs-api-ext branch November 25, 2025 20:22
@sekmiller sekmiller removed their assignment Nov 25, 2025
@pdurbin pdurbin added this to the 6.9 milestone Nov 25, 2025
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Dec 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY26 Sprint 8 FY26 Sprint 8 (2025-10-08 - 2025-10-22) FY26 Sprint 9 FY26 Sprint 9 (2025-10-22 - 2025-11-05) FY26 Sprint 10 FY26 Sprint 10 (2025-11-05 - 2025-11-19) FY26 Sprint 11 FY26 Sprint 11 (2025-11-20 - 2025-12-03) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 3 Size: 3 A percentage of a sprint. 2.1 hours. SPA.Q3.2025.6 Account: Notifications SPA These changes are required for the Dataverse SPA

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

Update Notifications API response values

7 participants