refactoring

[akkoma] / docs / api / pleroma_api.md

diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md
index e76a35b3b1720c042acb8c7e80bc22126d3692e4..7d343e97ad3c1076981e484865732e1f1aa12705 100644 (file)
--- a/docs/api/pleroma_api.md
+++ b/docs/api/pleroma_api.md
@@ -126,14 +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/v1/notifications/read`
+## `/api/v1/pleroma/notifications/read`
 ### Mark notifications as read
 * Method `POST`
 * Authentication: required
 * 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. In case of `max_id`, only the first 80 notifications will be returned.
+* 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