Skip to content

MSC2414: Make reason and score parameters optional for reporting content #2414

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

Merged
merged 9 commits into from
Oct 7, 2020
Merged

MSC2414: Make reason and score parameters optional for reporting content #2414

Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6005c16
Merge pull request #1 from matrix-org/master
iinuwa Dec 21, 2019
692d039
Merge branch 'master' of github.com:iinuwa/matrix-doc
iinuwa Jan 14, 2020
72bc0e0
Add proposal to make reason option on content reporting
iinuwa Jan 14, 2020
2563711
Rename proposal with proper ID.
iinuwa Jan 18, 2020
bbad4c4
Add backwards-compatibility notes.
iinuwa Jun 20, 2020
9be28c5
Add proposal to remove score; reorganize
iinuwa Sep 23, 2020
07dbdab
Fix typos
iinuwa Sep 23, 2020
51b278e
Mention the endpoint
turt2live Oct 2, 2020
02512f0
Use endpoint instead of API
iinuwa Oct 2, 2020
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
43 changes: 43 additions & 0 deletions proposals/2414-optional-content-reporting-reason.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# 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.

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 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 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
[hard-code]: https://github.com/matrix-org/matrix-react-sdk/pull/3290/files#diff-551ca16d6a8ffb96888b337b5246402dR66