From 6f333bf262ac20f6d5d3e246f1a1185bd6310fce Mon Sep 17 00:00:00 2001 From: KernelDeimos Date: Sat, 15 Jun 2024 19:13:11 -0400 Subject: [PATCH] doc: update notification doc --- doc/api/notifications.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/doc/api/notifications.md b/doc/api/notifications.md index b9d62fd2..0674d1ce 100644 --- a/doc/api/notifications.md +++ b/doc/api/notifications.md @@ -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