diff options
| author | Maksim Pechnikov <parallel588@gmail.com> | 2019-09-06 14:01:07 +0300 |
|---|---|---|
| committer | Maksim Pechnikov <parallel588@gmail.com> | 2019-09-06 14:01:07 +0300 |
| commit | eb74c3d5c7a4bebbee43e123661d87e7605a32ba (patch) | |
| tree | 5a034ddf84ce2fb0bb72501b146df967299c3685 /docs | |
| parent | 6ef0103ca0b194971a2e6f61685316536b742a11 (diff) | |
| parent | 896ffabe37406e85c2a3c2f30d2e882c68b5831e (diff) | |
| download | pleroma-eb74c3d5c7a4bebbee43e123661d87e7605a32ba.tar.gz | |
Merge branch 'develop' into issue/1218
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/differences_in_mastoapi_responses.md | 1 | ||||
| -rw-r--r-- | docs/api/pleroma_api.md | 11 |
2 files changed, 7 insertions, 5 deletions
diff --git a/docs/api/differences_in_mastoapi_responses.md b/docs/api/differences_in_mastoapi_responses.md index f34e3dd72..02f90f3e8 100644 --- a/docs/api/differences_in_mastoapi_responses.md +++ b/docs/api/differences_in_mastoapi_responses.md @@ -26,6 +26,7 @@ Has these additional fields under the `pleroma` object: - `content`: a map consisting of alternate representations of the `content` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain` - `spoiler_text`: a map consisting of alternate representations of the `spoiler_text` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain` - `expires_at`: a datetime (iso8601) that states when the post will expire (be deleted automatically), or empty if the post won't expire +- `thread_muted`: true if the thread the post belongs to is muted ## Attachments 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 |