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

Document schema of PusherData in push gateway API (#1968)

Browse source 
Fixes: #910
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
This commit is contained in:
Johannes Marbach 2024-10-29 16:10:59 +01:00 • committed by GitHub
parent b1ebbb9a1c
commit 32f41f88bc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 10 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/push_gateway/newsfragments/1968.clarification Normal file
View file

@ -0,0 +1 @@
Document the schema of `PusherData`.

12
data/api/push-gateway/push_notifier.yaml
View file

@ -182,9 +182,15 @@ paths:
type: object type: object
title: PusherData title: PusherData
description: |- description: |-
A dictionary of additional pusher-specific data. For A dictionary of additional pusher-specific data. This
'http' pushers, this is the data dictionary passed in at is the `data` dictionary passed in at
pusher creation minus the `url` key. [pusher creation](/client-server-api/#post_matrixclientv3pushersset)
minus the `url` key.
properties:
format:
type: string
description: |-
The format to use for sending notifications.
tweaks: tweaks:
type: object type: object
title: Tweaks title: Tweaks