2020-01-18 15:30:58 +01:00
|
|
|
# MSC2414: Make `reason` optional for reporting content
|
2020-01-14 04:36:38 +01:00
|
|
|
|
|
|
|
|
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`
|
2020-06-20 05:45:03 +02:00
|
|
|
parameters. The other endpoints mentioned in [#2367](https://github.com/matrix-org/matrix-doc/pull/2367) will also add
|
2020-01-14 04:36:38 +01:00
|
|
|
optional `reason` parameters, so it seems that it would be more more consistent
|
2020-06-20 05:45:03 +02:00
|
|
|
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.
|
