From 72bc0e0f6c6d7c4262ac18ae6eb7c2762ff11277 Mon Sep 17 00:00:00 2001 From: Isaiah Inuwa Date: Mon, 13 Jan 2020 21:36:38 -0600 Subject: [PATCH 1/7] Add proposal to make reason option on content reporting --- proposals/0000-optional-content-reporting-reason.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 proposals/0000-optional-content-reporting-reason.md diff --git a/proposals/0000-optional-content-reporting-reason.md b/proposals/0000-optional-content-reporting-reason.md new file mode 100644 index 00000000000..83fe7667702 --- /dev/null +++ b/proposals/0000-optional-content-reporting-reason.md @@ -0,0 +1,13 @@ +# MSC0000: Make `reason` optional for reporting content + +Currently, the spec says that the `reason` parameter on the content reporting +endpoint is required, but also says that the string "may be blank." This +seems to be a contradiction. + +This MSC proposes that the `required` flag for this parameter be removed, as +well as the "may be blank" clause in the description. + +Note that the kicking and banning endpoints already have optional `reason` +parameters. The other endpoints mentioned in #2367 will likely also add +optional `reason` parameters, so it seems that it would be more more consistent +with the rest of the spec to make this optional as well. \ No newline at end of file From 2563711ceb33329b58535ff5cb8b08792121c619 Mon Sep 17 00:00:00 2001 From: Isaiah Inuwa Date: Sat, 18 Jan 2020 08:30:58 -0600 Subject: [PATCH 2/7] Rename proposal with proper ID. --- ...ting-reason.md => 2414-optional-content-reporting-reason.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename proposals/{0000-optional-content-reporting-reason.md => 2414-optional-content-reporting-reason.md} (91%) diff --git a/proposals/0000-optional-content-reporting-reason.md b/proposals/2414-optional-content-reporting-reason.md similarity index 91% rename from proposals/0000-optional-content-reporting-reason.md rename to proposals/2414-optional-content-reporting-reason.md index 83fe7667702..66fd8fff2c3 100644 --- a/proposals/0000-optional-content-reporting-reason.md +++ b/proposals/2414-optional-content-reporting-reason.md @@ -1,4 +1,4 @@ -# MSC0000: Make `reason` optional for reporting content +# MSC2414: Make `reason` optional for reporting content Currently, the spec says that the `reason` parameter on the content reporting endpoint is required, but also says that the string "may be blank." This From bbad4c453ffc48bc563b5d02f7c8226b0152bfdc Mon Sep 17 00:00:00 2001 From: Isaiah Inuwa Date: Fri, 19 Jun 2020 22:45:03 -0500 Subject: [PATCH 3/7] Add backwards-compatibility notes. --- proposals/2414-optional-content-reporting-reason.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/proposals/2414-optional-content-reporting-reason.md b/proposals/2414-optional-content-reporting-reason.md index 66fd8fff2c3..a48a4991ae6 100644 --- a/proposals/2414-optional-content-reporting-reason.md +++ b/proposals/2414-optional-content-reporting-reason.md @@ -8,6 +8,12 @@ This MSC proposes that the `required` flag for this parameter be removed, as well as the "may be blank" clause in the description. Note that the kicking and banning endpoints already have optional `reason` -parameters. The other endpoints mentioned in #2367 will likely also add +parameters. The other endpoints mentioned in [#2367](https://github.com/matrix-org/matrix-doc/pull/2367) will also add optional `reason` parameters, so it seems that it would be more more consistent -with the rest of the spec to make this optional as well. \ No newline at end of file +with the rest of the spec to make this optional as well. + +## Backwards Compatibility + +Since servers currently expect this field to be sent by all clients, making +this optional is a breaking change. Clients should send query the version of +the homeserver to determine whether they can safely omit this field. From 9be28c5aded485786649a7da26e8fb41b2f0af39 Mon Sep 17 00:00:00 2001 From: iinuwa Date: Wed, 23 Sep 2020 16:34:46 -0500 Subject: [PATCH 4/7] Add proposal to remove score; reorganize --- .../2414-optional-content-reporting-reason.md | 44 ++++++++++++++----- 1 file changed, 34 insertions(+), 10 deletions(-) diff --git a/proposals/2414-optional-content-reporting-reason.md b/proposals/2414-optional-content-reporting-reason.md index a48a4991ae6..2504751598a 100644 --- a/proposals/2414-optional-content-reporting-reason.md +++ b/proposals/2414-optional-content-reporting-reason.md @@ -1,19 +1,43 @@ -# MSC2414: Make `reason` optional for reporting content +# MSC2414: Make `reason` and `score` optional for reporting content + +## Proposal +This MSC proposes to remove the `required` flag for both the `reason` and `score` +parameters, as well as the "may be blank" clause in the description of `reason`. + +## Rationale + +### `reason` Parameter Currently, the spec says that the `reason` parameter on the content reporting endpoint is required, but also says that the string "may be blank." This seems to be a contradiction. -This MSC proposes that the `required` flag for this parameter be removed, as -well as the "may be blank" clause in the description. - Note that the kicking and banning endpoints already have optional `reason` -parameters. The other endpoints mentioned in [#2367](https://github.com/matrix-org/matrix-doc/pull/2367) will also add -optional `reason` parameters, so it seems that it would be more more consistent -with the rest of the spec to make this optional as well. +parameters. The other membership endpoints mentioned in +[#2367][membership-endpoints] will also add optional `reason` parameters, +so it seems that it would be more more consistent with the rest of the spec +to make this optional as well. + +### `score` Parameter + +The spec also requires the `score` parameter, but its usefulness is limited. +Offensiveness is difficult to measure, and is likely not going to be applied +consistently across several rooms. Because of this ambiguity, it seems, many +clients [simply hard-code the integer value][hard-code]. + +To make this useful, for example, room administrators would need a way to map more +specific values to the integer range and perhaps even instruct the client to +display those mappings to the user. That may be possible to do in a closed +client/homeserver implementation, but not generally across the Matrix protocol. + +Making `score` optional would enable this feature to be used in specific contexts +while not forcing clients to support the ambiguity it brings. ## Backwards Compatibility -Since servers currently expect this field to be sent by all clients, making -this optional is a breaking change. Clients should send query the version of -the homeserver to determine whether they can safely omit this field. +Since servers currently expect these field to be sent by all clients, making +theme optional is a breaking change. Clients should check the spec versions +the homeserver supports to detect this change. + +[membership-endpoints]: https://github.com/matrix-org/matrix-doc/pull/2367 +[hard-code]: https://github.com/matrix-org/matrix-react-sdk/pull/3290/files#diff-551ca16d6a8ffb96888b337b5246402dR66 From 07dbdab89806ee40c4185c5577c46ea76aad34e3 Mon Sep 17 00:00:00 2001 From: iinuwa Date: Wed, 23 Sep 2020 16:37:26 -0500 Subject: [PATCH 5/7] Fix typos --- proposals/2414-optional-content-reporting-reason.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/proposals/2414-optional-content-reporting-reason.md b/proposals/2414-optional-content-reporting-reason.md index 2504751598a..ddec865c65b 100644 --- a/proposals/2414-optional-content-reporting-reason.md +++ b/proposals/2414-optional-content-reporting-reason.md @@ -15,13 +15,13 @@ seems to be a contradiction. Note that the kicking and banning endpoints already have optional `reason` parameters. The other membership endpoints mentioned in [#2367][membership-endpoints] will also add optional `reason` parameters, -so it seems that it would be more more consistent with the rest of the spec -to make this optional as well. +so it would be more more consistent with the rest of the spec to make this +optional as well. ### `score` Parameter The spec also requires the `score` parameter, but its usefulness is limited. -Offensiveness is difficult to measure, and is likely not going to be applied +Offensiveness is difficult to measure and is likely not going to be applied consistently across several rooms. Because of this ambiguity, it seems, many clients [simply hard-code the integer value][hard-code]. @@ -35,8 +35,8 @@ while not forcing clients to support the ambiguity it brings. ## Backwards Compatibility -Since servers currently expect these field to be sent by all clients, making -theme optional is a breaking change. Clients should check the spec versions +Since servers currently expect these fields to be sent by all clients, making +them optional is a breaking change. Clients should check the spec versions the homeserver supports to detect this change. [membership-endpoints]: https://github.com/matrix-org/matrix-doc/pull/2367 From 51b278e0158707ca2bc8998201b20cff8224f6ee Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Fri, 2 Oct 2020 07:42:35 -0600 Subject: [PATCH 6/7] Mention the endpoint --- proposals/2414-optional-content-reporting-reason.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/proposals/2414-optional-content-reporting-reason.md b/proposals/2414-optional-content-reporting-reason.md index ddec865c65b..6c7c842d8dd 100644 --- a/proposals/2414-optional-content-reporting-reason.md +++ b/proposals/2414-optional-content-reporting-reason.md @@ -1,8 +1,10 @@ # MSC2414: Make `reason` and `score` optional for reporting content ## Proposal -This MSC proposes to remove the `required` flag for both the `reason` and `score` -parameters, as well as the "may be blank" clause in the description of `reason`. + +On the [report content API](https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-rooms-roomid-report-eventid) +we remove the `required` flag for both the `reason` and `score` parameters, as +well as the "may be blank" clause in the description of `reason`. ## Rationale From 02512f0f6994de68eaa51d371108fadcc950d6a9 Mon Sep 17 00:00:00 2001 From: iinuwa Date: Fri, 2 Oct 2020 09:12:18 -0500 Subject: [PATCH 7/7] Use endpoint instead of API Co-authored-by: Jonas Platte --- proposals/2414-optional-content-reporting-reason.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposals/2414-optional-content-reporting-reason.md b/proposals/2414-optional-content-reporting-reason.md index 6c7c842d8dd..43cdf6c72ff 100644 --- a/proposals/2414-optional-content-reporting-reason.md +++ b/proposals/2414-optional-content-reporting-reason.md @@ -2,7 +2,7 @@ ## Proposal -On the [report content API](https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-rooms-roomid-report-eventid) +On the [report content endpoint](https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-rooms-roomid-report-eventid) we remove the `required` flag for both the `reason` and `score` parameters, as well as the "may be blank" clause in the description of `reason`.