Merge 3c17aa3789 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-04-13 14:44:10 +02:00 · 2025-12-03 15:02:00 -07:00 · 2025-12-01 17:41:42 +00:00 · 2025-07-25 10:44:39 +02:00 · 2025-07-25 09:56:33 +02:00
4 changed files with 29 additions and 7 deletions
--- a/changelogs/client_server/newsfragments/2181.clarification
+++ b/changelogs/client_server/newsfragments/2181.clarification
@ -0,0 +1,2 @@
+Clarify that the stripped state in `invite_state` and `knock_state` in `GET /sync` response must
+include the full `m.room.member` event of the user.
--- 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: |-
--- a/data/api/client-server/sync.yaml
+++ b/data/api/client-server/sync.yaml
@ -374,8 +374,14 @@ paths:
                                    description: |-
                                      The [stripped state events](/client-server-api/#stripped-state) that form the
                                      invite state.
+
+                                      MUST also include the `m.room.member` event of the user with a membership of
+                                      `invite`, and using the same event format as joined rooms with the `event_id`
+                                      and `origin_server_ts` fields.
                                    items:
-                                      $ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml
+                                      anyOf:
+                                        - $ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml
+                                        - $ref: definitions/client_event_without_room_id.yaml
                                    type: array
                      knock:
                        title: Knocked rooms
@ -399,8 +405,14 @@ paths:
                                    description: |-
                                      The [stripped state events](/client-server-api/#stripped-state) that form the
                                      knock state.
+
+                                      MUST also include the `m.room.member` event of the user with a membership of
+                                      `knock`, and using the same event format as joined rooms with the `event_id` and
+                                      `origin_server_ts` fields.
                                    items:
-                                      $ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml
+                                      anyOf:
+                                        - $ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml
+                                        - $ref: definitions/client_event_without_room_id.yaml
                                    type: array
                      leave:
                        title: Left rooms
@ -633,6 +645,8 @@ paths:
                                "sender": "@alice:example.com",
                                "type": "m.room.member",
                                "state_key": "@bob:example.com",
+                                "event_id": "$19dl9d3848dJLle:example.com",
+                                "origin_server_ts": 1432735439654,
                                "content": {
                                  "membership": "invite"
                                }
@ -657,6 +671,8 @@ paths:
                                "sender": "@bob:example.com",
                                "type": "m.room.member",
                                "state_key": "@bob:example.com",
+                                "event_id": "$Fg83Kl3764di23a:example.com",
+                                "origin_server_ts": 143273039402,
                                "content": {
                                  "membership": "knock"
                                }
Author	SHA1	Message	Date
Kévin Commaille	0b5e2b445e	Merge `3c17aa3789` into `d28e05af87`	2025-12-03 15:02:00 -07: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
Kévin Commaille	3c17aa3789	Add changelog Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>	2025-07-25 10:44:39 +02:00
Kévin Commaille	506bc1a164	Clarify that stripped state in /sync response must include `m.room.member` event of user And that event has the same format as in join rooms, with `event_id` and `origin_server_ts`. This has always been the case in homeserver implementations. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>	2025-07-25 09:56:33 +02:00
				`@ -0,0 +1 @@`
				Usage of the `event_id_only` format for push notifications is not mandatory.