From 4951bfe168c668453728da07d851aefe9ddb8514 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Mon, 14 Oct 2024 08:53:14 +0200 Subject: [PATCH 1/4] Clarify that servers must forward custom keys in `PusherData` Relates to: #921 Signed-off-by: Johannes Marbach --- data/api/client-server/pusher.yaml | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/data/api/client-server/pusher.yaml b/data/api/client-server/pusher.yaml index b8997308a..b002bbea5 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 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: From ce97aa6a7c23dfb23e15d09ea35313361fcd86da Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Mon, 14 Oct 2024 08:58:55 +0200 Subject: [PATCH 2/4] Add changelog --- changelogs/client_server/newsfragments/1973.clarification | 1 + 1 file changed, 1 insertion(+) 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 000000000..115ebed2d --- /dev/null +++ b/changelogs/client_server/newsfragments/1973.clarification @@ -0,0 +1 @@ +Servers must forward custom keys in `PusherData` when sending notifications to the push gateway. From a6e562a11678508acfe18b2f677c36a6a62a66c6 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 29 Oct 2024 17:04:00 +0100 Subject: [PATCH 3/4] Update changelogs/client_server/newsfragments/1973.clarification Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> --- changelogs/client_server/newsfragments/1973.clarification | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelogs/client_server/newsfragments/1973.clarification b/changelogs/client_server/newsfragments/1973.clarification index 115ebed2d..27fc58639 100644 --- a/changelogs/client_server/newsfragments/1973.clarification +++ b/changelogs/client_server/newsfragments/1973.clarification @@ -1 +1 @@ -Servers must forward custom keys in `PusherData` when sending notifications to the push gateway. +Clarify that servers must forward custom keys in `PusherData` when sending notifications to the push gateway. From 5aaf99ac0400629967e4548a384a421d57cc0ead Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 29 Oct 2024 17:04:21 +0100 Subject: [PATCH 4/4] Update data/api/client-server/pusher.yaml Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> --- data/api/client-server/pusher.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/api/client-server/pusher.yaml b/data/api/client-server/pusher.yaml index b002bbea5..d2a592043 100644 --- a/data/api/client-server/pusher.yaml +++ b/data/api/client-server/pusher.yaml @@ -215,7 +215,7 @@ paths: 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` + 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: