Merge 2e0dcad0b4 into 8a2c58b1b1

Add changelog
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2026-02-17 11:33:42 +01:00 · 2025-03-28 16:31:19 -04:00 · 2025-02-21 17:07:38 +01:00 · 2025-02-21 16:51:18 +01:00 · 2025-02-21 16:50:26 +01:00
3 changed files with 45 additions and 3 deletions
--- a/changelogs/client_server/newsfragments/2077.clarification
+++ b/changelogs/client_server/newsfragments/2077.clarification
@ -0,0 +1 @@
+Fix the example of the `GET /sync` endpoint and the `m.room.member` example used in several places.
--- a/data/api/client-server/sync.yaml
+++ b/data/api/client-server/sync.yaml
@ -441,17 +441,57 @@ paths:
                          "state": {
                            "events": [
                              {
-                                "$ref": "../../event-schemas/examples/m.room.member.yaml"
+                                "content": {
+                                  "avatar_url": "mxc://example.org/SFHyPlCeYUSFFxlgbQYZmoEoe",
+                                  "displayname": "Example user",
+                                  "membership": "join"
+                                },
+                                "event_id": "$143273976499sgjks:example.org",
+                                "origin_server_ts": 1432735824653,
+                                "sender": "@example:example.org",
+                                "state_key": "@example:example.org",
+                                "type": "m.room.member",
+                                "unsigned": {
+                                  "age": 45603,
+                                  "membership": "join"
+                                }
                              }
                            ]
                          },
                          "timeline": {
                            "events": [
                              {
-                                "$ref": "../../event-schemas/examples/m.room.member.yaml"
+                                "content": {
+                                  "avatar_url": "mxc://example.org/SEsfnsuifSDFSSEF",
+                                  "displayname": "Alice Margatroid",
+                                  "membership": "join",
+                                  "reason": "Looking for support"
+                                },
+                                "event_id": "$143273582443PhrSn:example.org",
+                                "origin_server_ts": 1432735824653,
+                                "sender": "@alice:example.org",
+                                "state_key": "@alice:example.org",
+                                "type": "m.room.member",
+                                "unsigned": {
+                                  "age": 1234,
+                                  "membership": "join"
+                                }
                              },
                              {
-                                "$ref": "../../event-schemas/examples/m.room.message$m.text.yaml"
+                                "content": {
+                                  "body": "This is an example text message",
+                                  "format": "org.matrix.custom.html",
+                                  "formatted_body": "<b>This is an example text message</b>",
+                                  "msgtype": "m.text"
+                                },
+                                "event_id": "$143273582443PhrSn:example.org",
+                                "origin_server_ts": 1432735824653,
+                                "sender": "@example:example.org",
+                                "type": "m.room.message",
+                                "unsigned": {
+                                  "age": 1234,
+                                  "membership": "join"
+                                }
                              }
                            ],
                            "limited": true,
--- a/data/event-schemas/examples/m.room.member.yaml
+++ b/data/event-schemas/examples/m.room.member.yaml
@ -1,6 +1,7 @@
 {
  "$ref": "core/state_event.json",
  "state_key": "@alice:example.org",
+  "sender": "@alice:example.org",
  "type": "m.room.member",
  "content": {
    "membership": "join",
Author	SHA1	Message	Date
Kévin Commaille	3c4edd027e	Merge `2e0dcad0b4` into `8a2c58b1b1`	2025-03-28 16:31:19 -04:00
Kévin Commaille	2e0dcad0b4	Add changelog Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>	2025-02-21 17:07:38 +01:00
Kévin Commaille	6640e192fd	Fix the `m.room.member.yaml` example This is a `join` event, and the `sender` doesn't match the `state_key`, so the event couldn't pass the authorization rules. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>	2025-02-21 16:51:18 +01:00
Kévin Commaille	2243f836dd	Fix sync example The same event should not appear in `state` and in the `timeline` so we cannot use the same event twice. To provide a `state` example we assume that with lazy-loading the user did not get the state event for `@example:example.org`, so we add one since they sent a message in the timeline. The events that are referenced include a `room_id`, which doesn't appear on this endpoint, so we copy them without it. Finally, the `join` event of `@alice:example.org` is wrong because the sender does not match the state key, which wouldn't pass the authorization rules. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>	2025-02-21 16:50:26 +01:00
				`@ -0,0 +1 @@`
				Fix the example of the `GET /sync` endpoint and the `m.room.member` example used in several places.