From b885714d94aa694fe267e3d36318b12d48499934 Mon Sep 17 00:00:00 2001 From: Jimmy Cuadra Date: Thu, 13 Jun 2019 17:21:11 -0700 Subject: [PATCH] Remove the "required" designation from the `url` field of certain m.room.message msgtypes. Now that content referenced by the *m.audio*, *m.file*, *m.image*, and *m.video* message types can be encrypted, the `url` field is required *only* if the content is unencrypted. The "required" designation in the event schemas (which prefixes the field description with "Required" in bold in the generated HTML) is used to indicate fields which must always be present, and this is no longer the case. Signed-off-by: Jimmy Cuadra --- changelogs/client_server/newsfragments/2129.clarification | 1 + event-schemas/schema/m.room.message$m.audio | 3 +-- event-schemas/schema/m.room.message$m.file | 1 - event-schemas/schema/m.room.message$m.image | 1 - event-schemas/schema/m.room.message$m.video | 1 - 5 files changed, 2 insertions(+), 5 deletions(-) create mode 100644 changelogs/client_server/newsfragments/2129.clarification diff --git a/changelogs/client_server/newsfragments/2129.clarification b/changelogs/client_server/newsfragments/2129.clarification new file mode 100644 index 00000000..82ed4fce --- /dev/null +++ b/changelogs/client_server/newsfragments/2129.clarification @@ -0,0 +1 @@ +Remove "required" designation from the ``url`` field of certain ``m`.room.message` msgtypes. diff --git a/event-schemas/schema/m.room.message$m.audio b/event-schemas/schema/m.room.message$m.audio index 88b459ec..fb049fc9 100644 --- a/event-schemas/schema/m.room.message$m.audio +++ b/event-schemas/schema/m.room.message$m.audio @@ -28,7 +28,7 @@ properties: type: string url: description: |- - Required if the file is not encrypted. The URL (typically `MXC URI`_) + Required if the file is unencrypted. The URL (typically `MXC URI`_) to the audio clip. type: string file: @@ -40,7 +40,6 @@ properties: required: - msgtype - body - - url type: object type: enum: diff --git a/event-schemas/schema/m.room.message$m.file b/event-schemas/schema/m.room.message$m.file index 9f4fdf07..54a999ec 100644 --- a/event-schemas/schema/m.room.message$m.file +++ b/event-schemas/schema/m.room.message$m.file @@ -55,7 +55,6 @@ properties: required: - msgtype - body - - url type: object type: enum: diff --git a/event-schemas/schema/m.room.message$m.image b/event-schemas/schema/m.room.message$m.image index a466562a..8944ce96 100644 --- a/event-schemas/schema/m.room.message$m.image +++ b/event-schemas/schema/m.room.message$m.image @@ -30,7 +30,6 @@ properties: required: - msgtype - body - - url type: object type: enum: diff --git a/event-schemas/schema/m.room.message$m.video b/event-schemas/schema/m.room.message$m.video index b23c2392..1a3c3e40 100644 --- a/event-schemas/schema/m.room.message$m.video +++ b/event-schemas/schema/m.room.message$m.video @@ -61,7 +61,6 @@ properties: required: - msgtype - body - - url type: object type: enum: