From 88f0c56ad9f4622318bb19e2c0174b8ea67c4809 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Wed, 30 Oct 2024 11:33:44 +0100 Subject: [PATCH] Clarify that servers must forward custom keys in `PusherData` (#1973) Relates to: #921 Signed-off-by: Johannes Marbach --- .../client_server/newsfragments/1973.clarification | 1 + data/api/client-server/pusher.yaml | 14 +++++++++----- 2 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 changelogs/client_server/newsfragments/1973.clarification diff --git a/changelogs/client_server/newsfragments/1973.clarification b/changelogs/client_server/newsfragments/1973.clarification new file mode 100644 index 00000000..27fc5863 --- /dev/null +++ b/changelogs/client_server/newsfragments/1973.clarification @@ -0,0 +1 @@ +Clarify that servers must forward custom keys in `PusherData` when sending notifications to the push gateway. diff --git a/data/api/client-server/pusher.yaml b/data/api/client-server/pusher.yaml index b8997308..d2a59204 100644 --- a/data/api/client-server/pusher.yaml +++ b/data/api/client-server/pusher.yaml @@ -210,17 +210,21 @@ paths: type: object description: |- Required if `kind` is not `null`. A dictionary of information - for the pusher implementation itself. If `kind` is `http`, - this should contain `url` which is the URL to use to send - notifications to. + for the pusher implementation itself. + + 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 properties: url: type: string format: uri description: |- - Required if `kind` is `http`. The URL to use to send - notifications to. MUST be an HTTPS URL with a path of + Required if `kind` is `http`. The URL to use for sending + notifications. MUST be an HTTPS URL with a path of `/_matrix/push/v1/notify`. example: https://push-gateway.location.here/_matrix/push/v1/notify format: