mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-30 19:13:42 +01:00
00c6a866e2
Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
52 lines
2 KiB
YAML
52 lines
2 KiB
YAML
{
|
|
"type": "object",
|
|
"title": "Receipt Event",
|
|
"description": "Informs the client of new receipts.",
|
|
"allOf": [{
|
|
"$ref": "core-event-schema/event.yaml"
|
|
}],
|
|
"properties": {
|
|
"content": {
|
|
"type": "object",
|
|
"patternProperties": {
|
|
"^\\$": {
|
|
"type": "object",
|
|
"x-pattern": "$EVENT_ID",
|
|
"title": "Receipts",
|
|
"description": "The mapping of event ID to a collection of receipts for this event ID. The event ID is the ID of the event being acknowledged and *not* an ID for the receipt itself.",
|
|
"properties": {
|
|
"m.read": {
|
|
"type": "object",
|
|
"title": "Users",
|
|
"description": "A collection of users who have sent ``m.read`` receipts for this event.",
|
|
"patternProperties": {
|
|
"^@": {
|
|
"type": "object",
|
|
"title": "Receipt",
|
|
"description": "The mapping of user ID to receipt. The user ID is the entity who sent this receipt.",
|
|
"x-pattern": "$USER_ID",
|
|
"properties": {
|
|
"ts": {
|
|
"type": "number",
|
|
"description": "The timestamp the receipt was sent at."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": ["m.receipt"]
|
|
},
|
|
"room_id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["room_id", "type", "content"]
|
|
}
|