From fbcb6fe3a1cf272a47ca4b84a36c9dbe8dec291e Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 28 Nov 2025 13:52:52 +0100 Subject: [PATCH 1/2] Clarify that usage of event_id_only is not mandatory Fixes: #1026 Signed-off-by: Johannes Marbach --- .../client_server/newsfragments/2255.clarification | 1 + data/api/client-server/pusher.yaml | 13 ++++++++----- 2 files changed, 9 insertions(+), 5 deletions(-) create mode 100644 changelogs/client_server/newsfragments/2255.clarification diff --git a/changelogs/client_server/newsfragments/2255.clarification b/changelogs/client_server/newsfragments/2255.clarification new file mode 100644 index 00000000..5322eb4e --- /dev/null +++ b/changelogs/client_server/newsfragments/2255.clarification @@ -0,0 +1 @@ +Usage of `event_id_only` is not mandatory. diff --git a/data/api/client-server/pusher.yaml b/data/api/client-server/pusher.yaml index d2a59204..0e3b7648 100644 --- a/data/api/client-server/pusher.yaml +++ b/data/api/client-server/pusher.yaml @@ -230,11 +230,14 @@ paths: format: type: string description: |- - The format to send notifications in to Push Gateways if the - `kind` is `http`. The details about what fields the - homeserver should send to the push gateway are defined in the - [Push Gateway Specification](/push-gateway-api/). Currently the only format - available is 'event_id_only'. + The format in which to send notifications to the push gateway + if the `kind` is `http`. The details about what fields the + homeserver should include are defined in the + [Push Gateway Specification](/push-gateway-api/). If omitted, + the server is expected to populate all of the event-related fields + specified in [`/_matrix/push/v1/notify`](/push-gateway-api/#post_matrixpushv1notify). + enum: + - "event_id_only" append: type: boolean description: |- From 91b618cc6f74cbb55dbaddbb86332549ea43c1b5 Mon Sep 17 00:00:00 2001 From: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Date: Fri, 28 Nov 2025 15:56:30 +0000 Subject: [PATCH 2/2] Add a few more words to the changelog --- changelogs/client_server/newsfragments/2255.clarification | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelogs/client_server/newsfragments/2255.clarification b/changelogs/client_server/newsfragments/2255.clarification index 5322eb4e..4429fccf 100644 --- a/changelogs/client_server/newsfragments/2255.clarification +++ b/changelogs/client_server/newsfragments/2255.clarification @@ -1 +1 @@ -Usage of `event_id_only` is not mandatory. +Usage of the `event_id_only` format for push notifications is not mandatory.