github_mirrors/puter
1
0
Fork 0
mirror of https://github.com/HeyPuter/puter.git synced 2025-02-02 23:28:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: update notification doc

Browse Source
This commit is contained in:
KernelDeimos 2024-06-15 19:13:11 -04:00
parent 5f5bd6bd24
commit 6f333bf262
1 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/api/notifications.md
View File

@ -2,13 +2,32 @@
Endpoints for managing notifications.
## POST `/notif/mark-awk` (auth required)
### Description
The `/notif/mark-awk` endpoint marks the specified notification
as "awknowledged". This indicates that the user has chosen to either
dismiss or act on this notification.
### Parameters
| Name | Description | Default Value |
| ---- | ----------- | -------- |
| uid | UUID associated with the notification | **required** |
### Response
This endpoint responds with an empty object (`{}`).
## POST `/notif/mark-read` (auth required)
### Description
The `/notif/mark-read` endpoint marks the specified notification
as "read". This indicates that the user has chosen to either
dismiss or act on this notification.
The `/notif/mark-read` endpoint marks that the specified notification
has been shown to the user. It will not "pop up" as a new notification
if they load the gui again.
### Parameters