Clarify that read notifications are returned
authorrinpatch <rinpatch@sdf.org>
Wed, 4 Sep 2019 10:39:39 +0000 (13:39 +0300)
committerrinpatch <rinpatch@sdf.org>
Wed, 4 Sep 2019 10:39:39 +0000 (13:39 +0300)
docs/api/pleroma_api.md

index c08ee9ecd33584bdf92c86bfdbfb49f3da289e43..7d343e97ad3c1076981e484865732e1f1aa12705 100644 (file)
@@ -133,7 +133,7 @@ See [Admin-API](Admin-API.md)
 * 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