matrix-org / matrix-spec

The Matrix protocol specification
Apache License 2.0
170 stars 90 forks source link

"Requires authentication" phrasing can be confusing #1878

Open zecakeh opened 1 week ago

zecakeh commented 1 week ago

Link to problem area: https://spec.matrix.org/v1.10/client-server-api/#post_matrixclientv3accountpassword or https://spec.matrix.org/v1.10/client-server-api/#post_matrixclientv3accountdeactivate, for example, but it will be clearer in v1.11.

Issue As brought up in https://github.com/matrix-org/matrix-spec/pull/1843#issuecomment-2176362807, the "Requires authentication" line for endpoints is only for whether an access token is required or not. However some endpoints like /password and /deactivate do not require an access token but require authentication via UIAA.

The phrasing could be changed to something like "Requires access token", for example.