summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorLibravatar Vyr Cossont <VyrCossont@users.noreply.github.com>2024-06-07 01:51:13 -0700
committerLibravatar GitHub <noreply@github.com>2024-06-07 10:51:13 +0200
commitafcfa48a7dfc87e35ba32c42b1f37405565a5087 (patch)
tree2639a14b80046914e83f8a7f08f041e6cdfc19d4 /docs/api
parent[bugfix] Filter fixes (#2971) (diff)
downloadgotosocial-afcfa48a7dfc87e35ba32c42b1f37405565a5087.tar.xz
[feature] Implement filters_changed stream event (#2972)
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/swagger.yaml3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml
index 3946a37ce..6bb5b45ea 100644
--- a/docs/api/swagger.yaml
+++ b/docs/api/swagger.yaml
@@ -8651,7 +8651,7 @@ paths:
`update`: a new status has been received.
`notification`: a new notification has been received.
`delete`: a status has been deleted.
- `filters_changed`: not implemented.
+ `filters_changed`: filters (including keywords and statuses) have changed.
enum:
- update
- notification
@@ -8668,6 +8668,7 @@ paths:
If `event` = `update`, then the payload will be a JSON string of a status.
If `event` = `notification`, then the payload will be a JSON string of a notification.
If `event` = `delete`, then the payload will be a status ID.
+ If `event` = `filters_changed`, then there is no payload.
example: '{"id":"01FC3TZ5CFG6H65GCKCJRKA669","created_at":"2021-08-02T16:25:52Z","sensitive":false,"spoiler_text":"","visibility":"public","language":"en","uri":"https://gts.superseriousbusiness.org/users/dumpsterqueer/statuses/01FC3TZ5CFG6H65GCKCJRKA669","url":"https://gts.superseriousbusiness.org/@dumpsterqueer/statuses/01FC3TZ5CFG6H65GCKCJRKA669","replies_count":0,"reblogs_count":0,"favourites_count":0,"favourited":false,"reblogged":false,"muted":false,"bookmarked":fals…//gts.superseriousbusiness.org/fileserver/01JNN207W98SGG3CBJ76R5MVDN/header/original/019036W043D8FXPJKSKCX7G965.png","header_static":"https://gts.superseriousbusiness.org/fileserver/01JNN207W98SGG3CBJ76R5MVDN/header/small/019036W043D8FXPJKSKCX7G965.png","followers_count":33,"following_count":28,"statuses_count":126,"last_status_at":"2021-08-02T16:25:52Z","emojis":[],"fields":[]},"media_attachments":[],"mentions":[],"tags":[],"emojis":[],"card":null,"poll":null,"text":"a"}'
type: string
stream: