Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-23 11:34:09 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Clarify that servers must forward custom keys in PusherData

Browse source 
Relates to: #921
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
This commit is contained in:
Johannes Marbach 2024-10-14 08:53:14 +02:00
parent ae3673d2ef
commit 4951bfe168
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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 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: