Merge 77b37cb9a9 into d28e05af87

Clarify that usage of event_id_only is not mandatory (#2255 )
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2026-03-07 12:14:10 +01:00 · 2025-12-03 07:59:23 +00:00 · 2025-12-01 17:41:42 +00:00
2 changed files with 9 additions and 5 deletions
--- a/changelogs/client_server/newsfragments/2255.clarification
+++ b/changelogs/client_server/newsfragments/2255.clarification
@ -0,0 +1 @@
+Usage of the `event_id_only` format for push notifications is not mandatory.
--- 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: |-
Author	SHA1	Message	Date
Johannes Marbach	2dd6625339	Merge `77b37cb9a9` into `d28e05af87`	2025-12-03 07:59:23 +00:00
Johannes Marbach	d28e05af87	Clarify that usage of event_id_only is not mandatory (#2255 ) Some checks failed Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled Details Spec / 🔎 Check Event schema examples (push) Has been cancelled Details Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled Details Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled Details Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled Details Spec / 📢 Run towncrier for changelog (push) Has been cancelled Details Spell Check / Spell Check with Typos (push) Has been cancelled Details Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled Details Spec / 📖 Build the spec (push) Has been cancelled Details Spec / 🔎 Validate generated HTML (push) Has been cancelled Details Spec / 📖 Build the historical backup spec (push) Has been cancelled Details Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>	2025-12-01 17:41:42 +00:00
				`@ -0,0 +1 @@`
				Usage of the `event_id_only` format for push notifications is not mandatory.