matrix-spec-proposals/api/server-server/definitions/pdu_v4.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.          
        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.          
        example: ["$URLsafe-base64EncodedHash", "$Another_Event"]
    required:
      - auth_events
      - prev_events