summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorLibravatar Vyr Cossont <VyrCossont@users.noreply.github.com>2024-06-17 12:50:50 -0700
committerLibravatar GitHub <noreply@github.com>2024-06-17 20:50:50 +0100
commitb08c1bd0cbf6986e59247deefbabb150db83aadd (patch)
tree45d47345c2cf46ddf50533be16470edd17a1da2a /docs/api
parent[chore]: Bump github.com/spf13/cobra from 1.8.0 to 1.8.1 (#3016) (diff)
downloadgotosocial-b08c1bd0cbf6986e59247deefbabb150db83aadd.tar.xz
[feature] Implement types[] param for notifications (#3009)
Counterpart of exclude_types[]. Also updates Swagger spec for types[] to use the correct param name and enumerate possible values. Fixes #3003
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/swagger.yaml29
1 files changed, 27 insertions, 2 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml
index 46ed95c82..4dfddd8f3 100644
--- a/docs/api/swagger.yaml
+++ b/docs/api/swagger.yaml
@@ -7427,10 +7427,35 @@ paths:
in: query
name: limit
type: integer
- - in: query
+ - description: Types of notifications to include. If not provided, all notification types will be included.
+ in: query
items:
+ enum:
+ - follow
+ - follow_request
+ - mention
+ - reblog
+ - favourite
+ - poll
+ - status
+ - admin.sign_up
+ type: string
+ name: types[]
+ type: array
+ - description: Types of notifications to exclude.
+ in: query
+ items:
+ enum:
+ - follow
+ - follow_request
+ - mention
+ - reblog
+ - favourite
+ - poll
+ - status
+ - admin.sign_up
type: string
- name: exclude_types
+ name: exclude_types[]
type: array
produces:
- application/json