diff options
| author | Haelwenn <contact+git.pleroma.social@hacktivis.me> | 2019-09-04 10:46:49 +0000 |
|---|---|---|
| committer | Haelwenn <contact+git.pleroma.social@hacktivis.me> | 2019-09-04 10:46:49 +0000 |
| commit | e54694748bdcc27a3acd3ff3feac5c0c284d8b0d (patch) | |
| tree | efd329ebcfdd39b2fe4c6592a0d96b10034268e9 /docs | |
| parent | 46ffd8b3b6359ec796733a8fff5bdb7d03a728d5 (diff) | |
| parent | 328b2612cd957aa3ad810101a20037e4e9843bb0 (diff) | |
| download | pleroma-e54694748bdcc27a3acd3ff3feac5c0c284d8b0d.tar.gz | |
Merge branch 'feature/mastoapi-read-notifications' into 'develop'
Extend `/api/pleroma/notifications/read` to mark multiple notifications as read and make it respond with Mastoapi entities
See merge request pleroma/pleroma!1625
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/pleroma_api.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md index b134b31a8..7d343e97a 100644 --- a/docs/api/pleroma_api.md +++ b/docs/api/pleroma_api.md @@ -126,13 +126,14 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi ## `/api/pleroma/admin/`… See [Admin-API](Admin-API.md) -## `/api/pleroma/notifications/read` -### Mark a single notification as read +## `/api/v1/pleroma/notifications/read` +### Mark notifications as read * Method `POST` * Authentication: required -* Params: - * `id`: notification's id -* Response: JSON. Returns `{"status": "success"}` if the reading was successful, otherwise returns `{"error": "error_msg"}` +* Params (mutually exclusive): + * `id`: a single notification id to read + * `max_id`: read all notifications up to this id +* Response: Notification entity/Array of Notification entities that were read. In case of `max_id`, only the first 80 read notifications will be returned. ## `/api/v1/pleroma/accounts/:id/subscribe` ### Subscribe to receive notifications for all statuses posted by a user |