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
53 lines
1.9 KiB
YAML
53 lines
1.9 KiB
YAML
# Copyright 2019 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.
|
|
type: object
|
|
title: Persistent Data Unit
|
|
description: A persistent data unit (event) for room version 4 and beyond.
|
|
example:
|
|
$ref: "../examples/pdu_v4.json"
|
|
allOf:
|
|
- $ref: "pdu_v3.yaml"
|
|
- type: object
|
|
properties:
|
|
redacts:
|
|
type: string
|
|
description: For redaction events, the ID of the event being redacted.
|
|
example: "$def_456-oldevent"
|
|
auth_events:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Event ID.
|
|
description: |-
|
|
Event IDs 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.
|
|
example: ["$URLsafe-base64EncodedHash", "$Another_Event"]
|
|
prev_events:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Event ID.
|
|
description: |-
|
|
Event IDs 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.
|
|
example: ["$URLsafe-base64EncodedHash", "$Another_Event"]
|
|
required:
|
|
- auth_events
|
|
- prev_events
|