zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Fix notification query param LIMIT doc #24684 (#1210) 

* Fix notification query param LIMIT doc

The notification query param LIMIT should return 40 notifications as default & Maximum notifications depends on the LIMIT param as evident from the code in api/v1/notifications_controller

* LIMIT param default & max notifications updated

* limit param doc updated
This commit is contained in:
Manish Roy 2023-12-09 02:55:44 +05:30 committed by GitHub
parent 8a274aaf39
commit b87c68c120
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
content/en/methods/notifications.md
View File

@ -46,7 +46,8 @@ Types to filter include:
3.1.0 - added `follow_request` type\
3.3.0 - added `status` type; both `min_id` and `max_id` can be used at the same time now\
3.5.0 - added `types`; add `update` and `admin.sign_up` types\
4.0.0 - added `admin.report` type
4.0.0 - added `admin.report` type\
4.1.0 - notification limit changed from 15 (max 30) to 40 (max 80)
#### Request
@ -67,7 +68,7 @@ min_id
: String. Returns results immediately newer than this ID. In effect, sets a cursor at this ID and paginates forward.
limit
: Integer. Maximum number of results to return. Defaults to 15 notifications. Max 30 notifications.
: Integer. Maximum number of results to return. Defaults to 40 notifications. Max 80 notifications.
types[]
: Array of String. Types to include in the result.
@ -394,4 +395,4 @@ Invalid or missing Authorization header.
{{< page-relref ref="methods/push" caption="push API methods" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/notifications_controller.rb" caption="app/controllers/api/v1/notifications_controller.rb" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/notifications_controller.rb" caption="app/controllers/api/v1/notifications_controller.rb" >}}