diff --git a/changelogs/client_server/newsfragments/2167.clarification b/changelogs/client_server/newsfragments/2167.clarification new file mode 100644 index 00000000..99805f73 --- /dev/null +++ b/changelogs/client_server/newsfragments/2167.clarification @@ -0,0 +1 @@ +Clarify that `format` is required if `formatted_body` is specified. diff --git a/data/event-schemas/schema/m.room.message$m.audio.yaml b/data/event-schemas/schema/m.room.message$m.audio.yaml index 825419bd..6bb23c31 100644 --- 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: diff --git a/data/event-schemas/schema/m.room.message$m.emote.yaml b/data/event-schemas/schema/m.room.message$m.emote.yaml index 43e2639d..b611b888 100644 --- 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: |- diff --git a/data/event-schemas/schema/m.room.message$m.file.yaml b/data/event-schemas/schema/m.room.message$m.file.yaml index 8e269366..65a7b3d6 100644 --- 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: diff --git a/data/event-schemas/schema/m.room.message$m.image.yaml b/data/event-schemas/schema/m.room.message$m.image.yaml index 15bdeda4..9017b945 100644 --- 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: diff --git 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 index 43882ab9..a773ebda 100644 --- 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: |- diff --git a/data/event-schemas/schema/m.room.message$m.notice.yaml b/data/event-schemas/schema/m.room.message$m.notice.yaml index 7b735d60..8c59149c 100644 --- 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: |- diff --git a/data/event-schemas/schema/m.room.message$m.text.yaml b/data/event-schemas/schema/m.room.message$m.text.yaml index 4cba2bd6..7171b82a 100644 --- 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: |- diff --git a/data/event-schemas/schema/m.room.message$m.video.yaml b/data/event-schemas/schema/m.room.message$m.video.yaml index 75752534..325c231a 100644 --- 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: