mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-24 09:58:38 +01:00
36b02edfc2
Fixes #3305 Fixes #3380 The idea here is to better distinguish between a 'raw' event (as we send over the wire), and the 'serialised' format, as sent in responses to the C-S api and in `PUT /_matrix/app/v1/transactions/{txnId}`. It's made more complicated by the fact that there are _two_ serialisation formats, one used by `/sync` and `/notifications`, and one by everything else (the difference being whether `room_id` is included). In an ideal world, we wouldn't repeat `SerialisedEvent` every time it's used, and instead just link to the first reference, but that's a job for another day. Another job for another day is to get rid of things like `sync_state_event.yaml` (which is now used only in one place, so should be inlined.)
48 lines
1.7 KiB
YAML
48 lines
1.7 KiB
YAML
# Copyright 2022 The Matrix.org Foundation C.I.C.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
title: ClientEvent
|
|
description: |-
|
|
The format used for events when they are returned from a homeserver to a client
|
|
via the Client-Server API, or sent to an Application Service via the Application Services API.
|
|
type: object
|
|
allOf:
|
|
- $ref: "client_event_without_room_id.yaml"
|
|
- properties:
|
|
room_id:
|
|
description: The ID of the room associated with this event.
|
|
type: string
|
|
example: '!jEsUZKDJdhlrceRyVU:example.org'
|
|
|
|
unsigned:
|
|
properties:
|
|
redacted_because:
|
|
title: ClientEvent
|
|
example: {
|
|
"type": "m.room.redaction",
|
|
"sender": "@moderator:example.org",
|
|
"content": {
|
|
"reason": "spam"
|
|
},
|
|
"redacts": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
|
|
"event_id": "$Nhl3rsgHMjk-DjMJANawr9HHAhLg4GcoTYrSiYYGqEE",
|
|
"origin_server_ts": 1632491098485,
|
|
"room_id": '!jEsUZKDJdhlrceRyVU:example.org',
|
|
"unsigned": {
|
|
"age": 1257,
|
|
}
|
|
}
|
|
required:
|
|
- room_id
|