diff options
Diffstat (limited to 'docs/USERGUIDE.md')
| -rw-r--r-- | docs/USERGUIDE.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/USERGUIDE.md b/docs/USERGUIDE.md index 7bd695b..de5ce3f 100644 --- a/docs/USERGUIDE.md +++ b/docs/USERGUIDE.md @@ -327,8 +327,9 @@ what it is about and dismisses it. ``` GET /v1/notifications → {"notifications": [{id, kind, group_id, title, link, read, created_at}], "unread": 3} -POST /v1/notifications/{id}/read → mark one read -POST /v1/notifications/read-all → mark every one read +DELETE /v1/notifications/{id} → dismiss one — the row is deleted +POST /v1/notifications/{id}/read → the same thing, under the name older clients use +POST /v1/notifications/read-all → dismiss every one DELETE /v1/notifications → delete them all POST /v1/groups/{group_id}/mute {"muted": true} ``` @@ -1099,8 +1100,9 @@ There is no hub endpoint that touches group key material. | Method | Path | Auth | Description | |---|---|---|---| | GET | `/v1/notifications` | Access token | Your notifications, newest first, plus an `unread` count. Chat is one entry per group. | -| POST | `/v1/notifications/{id}/read` | Access token | Mark one read. | -| POST | `/v1/notifications/read-all` | Access token | Mark all read. | +| DELETE | `/v1/notifications/{id}` | Access token | Dismiss one. The row is deleted — a notification is a signal, not a record, and the group, the message and the invitation it pointed at are all still there. | +| POST | `/v1/notifications/{id}/read` | Access token | The same thing. Kept because the interface ships inside the desktop package, so a hub is always answering some client older than itself. | +| POST | `/v1/notifications/read-all` | Access token | Dismiss every one. Same as `DELETE /v1/notifications`. | | DELETE | `/v1/notifications` | Access token | Delete all of yours. | | POST | `/v1/groups/{group_id}/mute` | Access token (member) | Body: `muted`. A muted group creates no notifications at all. | |