Skip to content

docs(api): add description for POST /notifications/read #15577

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.

Sign up for GitHub

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

Open
harininr wants to merge 1 commit into
base: develop
Choose a base branch
from
+6 −1
Open

docs(api): add description for POST /notifications/read #15577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion website/server/controllers/api-v3/notifications.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,15 @@ api.readNotification = {

/**
* @api {post} /api/v3/notifications/read Mark multiple notifications as read
* @apiDescription Marks multiple notifications as read by removing them
* from the user's notification list. This differs from marking notifications
* as seen, which retains them but sets the `seen` field to true.
* @apiName ReadNotifications
* @apiGroup Notification
*
* @apiSuccess {Object} data user.notifications
* @apiParam {String[]} notificationIds Required. Array of notification ID strings to mark as read.
*
* @apiSuccess {Object[]} data Array of remaining user notifications
*/
api.readNotifications = {
method: 'POST',
Expand Down