Skip to content

Commit b26aa7f

Browse files
Remove 'room_id' field from m.typing, m.receipt and m.fully_read examples and schema (#3679)
The spec had an erroneous `room_id` field in a m.typing EDU entry of /sync, `m.read` receipts in `/sync`, and `m.fully_read` room account data objects in the spec. None of these are necessary nor used in practice. Checking part of the ecosystem for whether clients look for, or homeservers include, these room_id fields, I found that: Element does not require them, nor does Synapse include them. Ruma does not include them. Dendrite does not include them. nheko/mtxclient does not look for them. This change removes room_id from the example and OpenAPI schema in each case mentioned above. It only affects the Client-Server spec - the Server-Server spec text remains unchanged. The field was initially introduced in 0f28f83.
1 parent 419d8cb commit b26aa7f

File tree

6 files changed

+5
-16
lines changed

6 files changed

+5
-16
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Remove erroneous `room_id` field from examples of `m.read`, `m.typing` in `/sync` and `m.fully_read` in room account data.
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
{
2-
"$ref": "event.json",
3-
"room_id": "!jEsUZKDJdhlrceRyVU:example.org"
2+
"$ref": "event.json"
43
}

data/event-schemas/examples/m.fully_read.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
{
22
"$ref": "core/event.json",
33
"type": "m.fully_read",
4-
"room_id": "!somewhere:example.org",
54
"content": {
65
"event_id": "$someplace:example.org"
76
}

data/event-schemas/schema/m.fully_read.yaml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@
1919
"type": {
2020
"type": "string",
2121
"enum": ["m.fully_read"]
22-
},
23-
"room_id": {
24-
"type": "string",
25-
"description": "The room ID the read marker applies to."
2622
}
2723
},
28-
"required": ["type", "room_id", "content"]
24+
"required": ["type", "content"]
2925
}

data/event-schemas/schema/m.receipt.yaml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,7 @@
4242
"type": {
4343
"type": "string",
4444
"enum": ["m.receipt"]
45-
},
46-
"room_id": {
47-
"type": "string"
4845
}
4946
},
50-
"required": ["room_id", "type", "content"]
47+
"required": ["type", "content"]
5148
}

data/event-schemas/schema/m.typing.yaml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,7 @@
2222
"type": {
2323
"type": "string",
2424
"enum": ["m.typing"]
25-
},
26-
"room_id": {
27-
"type": "string"
2825
}
2926
},
30-
"required": ["type", "room_id", "content"]
27+
"required": ["type", "content"]
3128
}

0 commit comments

Comments
 (0)