mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-03 14:38:37 +01:00
71 lines
2.3 KiB
YAML
71 lines
2.3 KiB
YAML
|
# Copyright 2018 New Vector Ltd
|
||
|
|
#
|
||
|
|
# 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.
|
||
|
|
type: object
|
||
|
|
title: Persistent Data Unit
|
||
|
|
description: A persistent data unit (event) for room versions 1 and 2.
|
||
|
|
example:
|
||
|
|
$ref: "../examples/pdu_v1.json"
|
||
|
|
allOf:
|
||
|
|
- $ref: "components/pdu_base.yaml"
|
||
|
|
- type: object
|
||
|
|
properties:
|
||
|
|
event_id:
|
||
|
|
type: string
|
||
|
|
description: The event ID for the PDU.
|
||
|
|
example: "$a4ecee13e2accdadf56c1025:example.com"
|
||
|
|
redacts:
|
||
|
|
type: string
|
||
|
|
description: For redaction events, the ID of the event being redacted.
|
||
|
|
example: "$def456:matrix.org"
|
||
|
|
auth_events:
|
||
|
|
type: array
|
||
|
|
description: |-
|
||
|
|
Event IDs and reference hashes for the authorization events that would
|
||
|
|
allow this event to be in the room.
|
||
|
|
|
||
|
|
Must contain less than or equal to 10 events. Note that if the relevant
|
||
|
|
auth event selection rules are used, this restriction should never be
|
||
|
|
encountered.
|
||
|
|
items:
|
||
|
|
type: array
|
||
|
|
maxItems: 2
|
||
|
|
minItems: 2
|
||
|
|
items:
|
||
|
|
anyOf:
|
||
|
|
- type: string
|
||
|
|
title: Event ID
|
||
|
|
example: "$abc123:matrix.org"
|
||
|
|
- $ref: "components/event_hash.yaml"
|
||
|
|
prev_events:
|
||
|
|
type: array
|
||
|
|
description: |-
|
||
|
|
Event IDs and reference hashes for the most recent events in the room
|
||
|
|
that the homeserver was aware of when it made this event.
|
||
|
|
|
||
|
|
Must contain less than or equal to 20 events.
|
||
|
|
items:
|
||
|
|
type: array
|
||
|
|
maxItems: 2
|
||
|
|
minItems: 2
|
||
|
|
items:
|
||
|
|
anyOf:
|
||
|
|
- type: string
|
||
|
|
title: Event ID
|
||
|
|
example: "$abc123:matrix.org"
|
||
|
|
- $ref: "components/event_hash.yaml"
|
||
|
|
required:
|
||
|
|
- event_id
|
||
|
|
- auth_events
|
||
|
|
- prev_events
|