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

Filters: improve documentation (#661) 

* Filters: extra info about 'irreversible'

* Reformulate documentation of irreversible flag

* Filters: expired_in does not delete the filter

Also some clarification about context.
This commit is contained in:
Alex Schroeder 2018-08-27 11:16:58 +02:00 committed by Eugen Rochko
parent 7df7e57f9b
commit f5a01ab9ee
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Using-the-API/API.md
View File

@ -350,14 +350,20 @@ Returns an array of [Filters](#filter).
| Field | Description | Optional |
| ----------------- | ------------------------------------------------------------------- | ---------- |
| `phrase` | String that contains keyword or phrase | no |
| `context` | Array of strings that means filtering context. each string is one of 'home', 'notifications', 'public', 'thread'. At least one context must be specified | no. |
| `irreversible` | Boolean that indicates irreversible filtering on server side | yes |
| `phrase` | String that contains keyword or phrase. | no |
| `context` | Array of strings that means filtering context. Each string is one of 'home', 'notifications', 'public', 'thread'. At least one context must be specified. | no. |
| `irreversible` | Boolean that indicates irreversible filtering on server side. | yes |
| `whole_word` | Boolean that indicates word match. | yes |
| `expires_in` | Number that indicates seconds. Filter will be expire in seconds after API processed. null or blank string means "don't change". default is unlimited. | yes |
| `expires_in` | Number that indicates seconds. Filter will be expire in seconds after API processed. Null or blank string means "don't change". Default is unlimited. | yes |
Returns a [Filter](#filter).
Notes:
* The public context refers to both the local and the federated [timelines](#timelines); the home context refers to the home timeline. The thread context happens when looking at a status in [context](#context). No context applies when looking at the [statuses of an account](#getting-an-accounts-statuses).
* Clients must do their own filtering based on these filters. The server will apply "irreversible" filters for home and notifications context. Anything else is still up to the client to filter!
* Expired filters are not deleted by the server. They should no longer be applied but they are still stored by the server. It is up to clients to delete these filters eventually.
#### Get a filter.
GET /api/v1/filters/:id