Skip to content

Clarify that format is required if formatted_body is specified #2167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Clarify that format is required if formatted_body is specified #2167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4e294c
Clarify that format is required if formatted_body is specifed
Johennes Jun 24, 2025
5e15bbd
Add changelog
Johennes Jun 24, 2025
53150b7
Fix typo
Johennes Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2167.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that `format` is required if `formatted_body` is specified.
4 changes: 2 additions & 2 deletions data/event-schemas/schema/m.room.message$m.audio.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions data/event-schemas/schema/m.room.message$m.emote.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: |-
Expand Down
4 changes: 2 additions & 2 deletions data/event-schemas/schema/m.room.message$m.file.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions data/event-schemas/schema/m.room.message$m.image.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions data/event-schemas/schema/m.room.message$m.key.verification.request.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: |-
Expand Down
4 changes: 2 additions & 2 deletions data/event-schemas/schema/m.room.message$m.notice.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: |-
Expand Down
4 changes: 2 additions & 2 deletions data/event-schemas/schema/m.room.message$m.text.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: |-
Expand Down
4 changes: 2 additions & 2 deletions data/event-schemas/schema/m.room.message$m.video.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down