[Feature] Notifications for Publisher and Developer Portal in API Manager

[tharikaGitHub]

Problem

There are situations where decisions made or actions performed within one component of WSO2 API Manager are important to be notified to the relevant parties in other components. As currently we do not support this OOTB, there is a gap to be filled.

Solution

The purpose of this feature is to create a notification mechanism across components like Publisher and Developer Portal.

At the completion of this feature, the relevant stakeholders of API Publisher and Developer Portal will be informed about API and Application related operations that are important to them.

Affected Component

APIM

Version

4.x

Implementation

No response

Related Issues

No response

Suggested Labels

No response

[tharikaGitHub]

The following are the main sub tasks for the feature.

• Identify the list of scenarios to be implemented
• Plan on a design for the feature
• Create a design document
• Get the design reviewed
• Implement the backend changes required for the feature
• Implement the UI changes required for the feature
• Map the UI changes to the backend implementation
• Do the required manual testing for the feature
• Implement unit and integration tests
• Get the code reviewed
• Create documentation for the feature

[HelaniUdara]

Update: Project Progress

• Identified and documented a comprehensive list of scenarios for implementation.
• The detailed list of scenarios can be found here.

[HelaniUdara]

Update: Project Progress

• Formulated a design plan for the proposed feature and developed the design documentation.
• The design document is accessible via the following link: Design Document.

[HelaniUdara]

Update: Project Progress

• Conducted a comprehensive design review to assess project progress.
• Received valuable recommendations and suggestions during the review process.
• Access the proposed recommendations and suggestions through this link: Recommendations and Suggestions Document.
• Updated the design document based on received feedback.
• Access the updated design document via this link: Updated Design Document.

[HelaniUdara]

Update: Project Progress

• Implemented a pop-up for rejecting workflows in Admin Portal UI.
• Implemented basic notification insertion logic for workflow rejections and approvals.
• Developed Publisher UI (with hard-coded values) for notification feature.
• Created backend APIs for managing notifications in Publisher portal. Support ;
  • Get All Notifications
  • Mark a Notification as read
  • Delete a Notification
  • Clear All
  • Mark All as read
• Connected UI parts with backend APIs.

[HelaniUdara]

Project Update Summary:

• Successfully completed the project for workflow-related notifications.

• Submitted Pull Requests (PRs):

  • Backend Code PR: carbon-apimgt
  • Frontend Code PR: apim-apps
  • Documentation Repository PR: docs-apim

• The initial design underwent refinements during final discussions to align with project goals. Recommended changes can be accessed here.

• Final revised design documentation is available here: Final Design Doc.