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

Clarify that servers must forward custom keys in PusherData (#1973)

Browse source 
Relates to: #921
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
This commit is contained in:
Johannes Marbach 2024-10-30 11:33:44 +01:00 • committed by GitHub
parent 0b4d1c0237
commit 88f0c56ad9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 10 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/1973.clarification Normal file
View file

@ -0,0 +1 @@
Clarify that servers must forward custom keys in `PusherData` when sending notifications to the push gateway.

14
data/api/client-server/pusher.yaml
View file

@ -210,17 +210,21 @@ paths:
type: object type: object
description: |- description: |-
Required if `kind` is not `null`. A dictionary of information Required if `kind` is not `null`. A dictionary of information
for the pusher implementation itself. If `kind` is `http`, for the pusher implementation itself.
this should contain `url` which is the URL to use to send
notifications to. If `kind` is `http`, this MUST contain `url` which is the URL
to use for sending notifications. Clients MAY use this object
to pass custom data to their push gateway. Servers MUST forward
the entire content including `format` and any custom keys but excluding `url`
when calling [`/_matrix/push/v1/notify`](/push-gateway-api/#post_matrixpushv1notify).
title: PusherData title: PusherData
properties: properties:
url: url:
type: string type: string
format: uri format: uri
description: |- description: |-
Required if `kind` is `http`. The URL to use to send Required if `kind` is `http`. The URL to use for sending
notifications to. MUST be an HTTPS URL with a path of notifications. MUST be an HTTPS URL with a path of
`/_matrix/push/v1/notify`. `/_matrix/push/v1/notify`.
example: https://push-gateway.location.here/_matrix/push/v1/notify example: https://push-gateway.location.here/_matrix/push/v1/notify
format: format: