matrix-spec/data/event-schemas/schema/m.room.redaction.yaml

---
allOf:
  - $ref: core-event-schema/room_event.yaml
description: 'This event is created by the server to describe which event has been redacted, by whom, and optionally why. The event that has been redacted is specified in the `redacts` event level key. Redacting an event means that all keys not required by the protocol are stripped off, allowing messages to be hidden or allowing admins to remove offensive or illegal content.'
properties:
  content:
    properties:
      redacts:
        description: The event ID that was redacted. Required for, and present starting in, room version 11.
        type: string
      reason:
        description: 'The reason for the redaction, if any.'
        type: string
    type: object
  redacts:
    description: Required for, and only present in, room versions 1 - 10. The event ID that was redacted.
    type: string
  type:
    enum:
      - m.room.redaction
    type: string
title: Redaction
type: object
Convert event schemas to yaml We've decided to make the event schemas YAML, so we might as well take advantage of it. (This conversion was done mostly automatically, except for: - s/null/"null"/ in m.room.member - reformat description in m.room.power_levels 2016-06-22 12:03:02 +02:00			`---`
			`allOf:`
			`- $ref: core-event-schema/room_event.yaml`
Change RST code formatting markup to Markdown 2021-01-27 21:14:31 +01:00			description: 'This event is created by the server to describe which event has been redacted, by whom, and optionally why. The event that has been redacted is specified in the `redacts` event level key. Redacting an event means that all keys not required by the protocol are stripped off, allowing messages to be hidden or allowing admins to remove offensive or illegal content.'
Convert event schemas to yaml We've decided to make the event schemas YAML, so we might as well take advantage of it. (This conversion was done mostly automatically, except for: - s/null/"null"/ in m.room.member - reformat description in m.room.power_levels 2016-06-22 12:03:02 +02:00			`properties:`
			`content:`
			`properties:`
Add room version 11 (#1604) * Remove duplicate words. * Add information on room version 11. * Note some event changes. * Newsfragment * Fix-up event schema. * Apply suggestions from code review Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Fix 'new in this version'. * Clarify creator field. * Fix-up event format & examples. * Move the Redactions section to the client section. * Reference the sender instead of the creator. * More links * Even more links. * Fix order of headers. * Fix typos. Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Clarify description of creator. Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Clean-up intro paragraphs for redactions. * Clean-up examples and language. * Review comments. * FIx-up markup tags. --------- Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> 2023-08-15 08:18:45 +02:00			`redacts:`
			`description: The event ID that was redacted. Required for, and present starting in, room version 11.`
			`type: string`
Convert event schemas to yaml We've decided to make the event schemas YAML, so we might as well take advantage of it. (This conversion was done mostly automatically, except for: - s/null/"null"/ in m.room.member - reformat description in m.room.power_levels 2016-06-22 12:03:02 +02:00			`reason:`
			`description: 'The reason for the redaction, if any.'`
			`type: string`
			`type: object`
			`redacts:`
Add room version 11 (#1604) * Remove duplicate words. * Add information on room version 11. * Note some event changes. * Newsfragment * Fix-up event schema. * Apply suggestions from code review Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Fix 'new in this version'. * Clarify creator field. * Fix-up event format & examples. * Move the Redactions section to the client section. * Reference the sender instead of the creator. * More links * Even more links. * Fix order of headers. * Fix typos. Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Clarify description of creator. Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Clean-up intro paragraphs for redactions. * Clean-up examples and language. * Review comments. * FIx-up markup tags. --------- Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> 2023-08-15 08:18:45 +02:00			`description: Required for, and only present in, room versions 1 - 10. The event ID that was redacted.`
Convert event schemas to yaml We've decided to make the event schemas YAML, so we might as well take advantage of it. (This conversion was done mostly automatically, except for: - s/null/"null"/ in m.room.member - reformat description in m.room.power_levels 2016-06-22 12:03:02 +02:00			`type: string`
			`type:`
			`enum:`
			`- m.room.redaction`
			`type: string`
			`title: Redaction`
			`type: object`