From c99799ac3e1589c2ce81838ddf38f8ad6829237d Mon Sep 17 00:00:00 2001 From: Claire Date: Wed, 9 Oct 2024 16:54:13 +0200 Subject: [PATCH] Add documentation for `include_filtered` (#1543) * Add documentation for `include_filtered` * Update grouped_notifications.md --- content/en/methods/grouped_notifications.md | 3 +++ content/en/methods/notifications.md | 6 +++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/content/en/methods/grouped_notifications.md b/content/en/methods/grouped_notifications.md index d517ebf1..f0a54e01 100644 --- a/content/en/methods/grouped_notifications.md +++ b/content/en/methods/grouped_notifications.md @@ -86,6 +86,9 @@ expand_accounts grouped_types[] : Array of String. Restrict which notification types can be grouped. Use this if there are notification types for which your client does not support grouping. If omitted, the server will group notifications of all types it supports (currently, `favourite`, `follow` and `reblog`). If you do not want any notification grouping, use [GET `/api/v1/notifications`]({{< relref "methods/notifications#get" >}}) instead. Notifications that would be grouped if not for this parameter will instead be returned as individual single-notification groups with a unique `group_key` that can be assumed to be of the form `ungrouped-{notification_id}`. Please note that neither the streaming API nor the individual notification APIs are aware of this parameter and will always include a “proper” `group_key` that can be different from what is returned here, meaning that you may have to ignore `group_key` for such notifications that you do not want grouped and use `ungrouped-{notification_id}` instead for consistency. +include_filtered +: Boolean. Whether to include notifications filtered by the user's [NotificationPolicy]({{< relref "entities/NotificationPolicy" >}}). Defaults to false. + #### Response Sample call with limit=2. diff --git a/content/en/methods/notifications.md b/content/en/methods/notifications.md index 9d3ce750..d119c1ef 100644 --- a/content/en/methods/notifications.md +++ b/content/en/methods/notifications.md @@ -47,7 +47,8 @@ Types to filter include: 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.1.0 - notification limit changed from 15 (max 30) to 40 (max 80) +4.1.0 - notification limit changed from 15 (max 30) to 40 (max 80)\ +4.3.0 - added `include_filtered` parameter #### Request @@ -79,6 +80,9 @@ exclude_types[] account_id : String. Return only notifications received from the specified account. +include_filtered +: Boolean. Whether to include notifications filtered by the user's [NotificationPolicy]({{< relref "entities/NotificationPolicy" >}}). Defaults to false. + #### Response Sample call with limit=2.