Merge 53150b739b into 484a777572

Fix typo (#2171 )
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-13 15:04:10 +01:00 · 2025-07-03 18:20:25 +01:00 · 2025-07-02 11:20:48 +01:00 · 2025-06-24 08:29:03 +02:00 · 2025-06-24 08:27:43 +02:00 · 2025-06-24 08:21:10 +02:00
11 changed files with 19 additions and 17 deletions
--- a/changelogs/client_server/newsfragments/2167.clarification
+++ b/changelogs/client_server/newsfragments/2167.clarification
@ -0,0 +1 @@
+Clarify that `format` is required if `formatted_body` is specified.
--- a/changelogs/client_server/newsfragments/2171.clarification
+++ b/changelogs/client_server/newsfragments/2171.clarification
@ -0,0 +1 @@
+Fix various typos throughout the specification.
--- a/content/client-server-api/modules/event_replacements.md
+++ b/content/client-server-api/modules/event_replacements.md
@ -364,7 +364,7 @@ property under `m.new_content`.

 A particular constraint applies to events which replace a [reply](#rich-replies):
 in contrast to the original reply, there should be no `m.in_reply_to` property
-in the the `m.relates_to` object, since it would be redundant (see
+in the `m.relates_to` object, since it would be redundant (see
 [Applying `m.new_content`](#applying-mnew_content) above, which notes that the
 original event's `m.relates_to` is preserved), as well as being contrary to the
 spirit of the event relationships mechanism which expects only one "parent" per
--- a/data/event-schemas/schema/m.room.message$m.audio.yaml
+++ b/data/event-schemas/schema/m.room.message$m.audio.yaml
@ -15,8 +15,8 @@ properties:
          "1.10": This property can act as a caption for the audio.
      format:
        description: |-
-          The format used in the `formatted_body`. Currently only
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
        x-addedInMatrixVersion: "1.10"
      formatted_body:
--- a/data/event-schemas/schema/m.room.message$m.emote.yaml
+++ b/data/event-schemas/schema/m.room.message$m.emote.yaml
@ -14,8 +14,8 @@ properties:
        type: string
      format:
        description: |-
-          The format used in the `formatted_body`. Currently only
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
      formatted_body:
        description: |-
--- a/data/event-schemas/schema/m.room.message$m.file.yaml
+++ b/data/event-schemas/schema/m.room.message$m.file.yaml
@ -15,8 +15,8 @@ properties:
          "1.10": This property can act as a caption for the file.
      format:
        description: |-
-          The format used in the `formatted_body`. Currently only
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
        x-addedInMatrixVersion: "1.10"
      formatted_body:
--- a/data/event-schemas/schema/m.room.message$m.image.yaml
+++ b/data/event-schemas/schema/m.room.message$m.image.yaml
@ -15,8 +15,8 @@ properties:
          "1.10": This property can act as a caption for the image.
      format:
        description: |-
-          The format used in the `formatted_body`. Currently only
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
        x-addedInMatrixVersion: "1.10"
      formatted_body:
--- a/data/event-schemas/schema/m.room.message$m.key.verification.request.yaml
+++ b/data/event-schemas/schema/m.room.message$m.key.verification.request.yaml
@ -22,8 +22,8 @@ properties:
          verification.
      format:
        description: |-
-          The format used in the `formatted_body`. Currently only
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
      formatted_body:
        description: |-
--- a/data/event-schemas/schema/m.room.message$m.notice.yaml
+++ b/data/event-schemas/schema/m.room.message$m.notice.yaml
@ -14,8 +14,8 @@ properties:
        type: string
      format:
        description: |-
-          The format used in the `formatted_body`. Currently only
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
      formatted_body:
        description: |-
--- a/data/event-schemas/schema/m.room.message$m.text.yaml
+++ b/data/event-schemas/schema/m.room.message$m.text.yaml
@ -14,8 +14,8 @@ properties:
        type: string
      format:
        description: |-
-          The format used in the `formatted_body`. Currently only
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
      formatted_body:
        description: |-
--- a/data/event-schemas/schema/m.room.message$m.video.yaml
+++ b/data/event-schemas/schema/m.room.message$m.video.yaml
@ -15,8 +15,8 @@ properties:
          "1.10": This property can act as a caption for the video.
      format:
        description: |-
-          The format used in the `formatted_body`. Currently only
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
        x-addedInMatrixVersion: "1.10"
      formatted_body:
Author	SHA1	Message	Date
Johannes Marbach	d20a46f864	Merge `53150b739b` into `484a777572`	2025-07-03 18:20:25 +01:00
Johannes Marbach	484a777572	Fix typo (#2171 ) Some checks failed Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled Details Spec / 🔎 Check Event schema examples (push) Has been cancelled Details Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled Details Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled Details Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled Details Spec / 📢 Run towncrier for changelog (push) Has been cancelled Details Spell Check / Spell Check with Typos (push) Has been cancelled Details Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled Details Spec / 📖 Build the spec (push) Has been cancelled Details Spec / 🔎 Validate generated HTML (push) Has been cancelled Details Spec / 📖 Build the historical backup spec (push) Has been cancelled Details Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>	2025-07-02 11:20:48 +01:00
Johannes Marbach	53150b739b	Fix typo	2025-06-24 08:29:03 +02:00
Johannes Marbach	5e15bbdbdd	Add changelog	2025-06-24 08:27:43 +02:00
Johannes Marbach	d4e294ca28	Clarify that format is required if formatted_body is specifed Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>	2025-06-24 08:21:10 +02:00
				`@ -0,0 +1 @@`
				Clarify that `format` is required if `formatted_body` is specified.
				`@ -0,0 +1 @@`
				`Fix various typos throughout the specification.`