wholetrans/docs-mastodon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add documentation for blur_media filter action (#1620)

Browse source 
* Add documentation for `blur_media` filter action

* Add `blur_media` documentation

* Rename `blur_media` to `blur`

* Rename `blur_media` to `blur`
This commit is contained in:
Claire 2025-03-26 10:45:57 +01:00 • committed by GitHub
parent 8bd02d87af
commit 3540a72082
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 10 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
content/en/entities/Filter.md
View file

@ -80,8 +80,10 @@ aliases: [
**Type:** String (Enumerable, oneOf)\
`warn` = show a warning that identifies the matching filter by `title`, and allow the user to expand the filtered status. This is the default (and unknown values should be treated as equivalent to `warn`).\
`hide` = do not show this status if it is received\
`blur` = hide/blur media attachments with a warning identifying the matching filter by `title`
**Version history:**\
4.0.0 - added
4.0.0 - added\
4.4.0 (`mastodon` [API version]({{< relref "entities/Instance#api-versions" >}}) 5) - added `blur` value to `filter_action` attribute
### `keywords` {#keywords}
@ -105,4 +107,4 @@ aliases: [
{{< page-relref ref="methods/filters" caption="/api/v2/filters methods" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/filter_serializer.rb" caption="app/serializers/rest/filter_serializer.rb" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/filter_serializer.rb" caption="app/serializers/rest/filter_serializer.rb" >}}

10
content/en/methods/filters.md
View file

@ -179,7 +179,8 @@ Create a filter group with the given parameters.
**Returns:** [Filter]({{< relref "entities/Filter" >}})\
**OAuth:** User token + `write:filters`\
**Version history:**\
4.0.0 - added
4.0.0 - added\
4.4.0 (`mastodon` [API version]({{< relref "entities/Instance#api-versions" >}}) 5) - added `blur` value to `filter_action` attribute
#### Request
@ -197,7 +198,7 @@ context[]
: {{<required>}} Array of String. Where the filter should be applied. Specify at least one of `home`, `notifications`, `public`, `thread`, `account`.
filter_action
: String. The policy to be applied when the filter is matched. Specify `warn` or `hide`.
: String. The policy to be applied when the filter is matched. Specify `warn`, `hide` or `blur`.
expires_in
: Integer. How many seconds from now should the filter expire?
@ -298,7 +299,8 @@ Update a filter group with the given parameters.
**Returns:** [Filter]({{< relref "entities/Filter" >}})\
**OAuth:** User token + `write:filters`\
**Version history:**\
4.0.0 - added
4.0.0 - added\
4.4.0 (`mastodon` [API version]({{< relref "entities/Instance#api-versions" >}}) 5) - added `blur` value to `filter_action` attribute
#### Request
@ -321,7 +323,7 @@ context[]
: Array of String. Where the filter should be applied. Specify at least one of `home`, `notifications`, `public`, `thread`, `account`.
filter_action
: String. The policy to be applied when the filter is matched. Specify `warn` or `hide`.
: String. The policy to be applied when the filter is matched. Specify `warn`, `hide` or `blur`.
expires_in
: Integer. How many seconds from now should the filter expire?