matrix-org / matrix-spec

The Matrix protocol specification
Apache License 2.0
188 stars 94 forks source link

All APIs should have a dedicated "Unsupported Endpoints" section #1815

Open turt2live opened 5 months ago

turt2live commented 5 months ago

Link to problem area:

Issue

A common thing I do is try to link to the 404/405 M_UNRECOGNIZED behaviour, but because it's buried in the "Common error codes", I need to include language to navigate the reader. Preferably, a section exists which can be directly linked to, like the following:

turt2live commented 5 months ago

https://github.com/element-hq/synapse/issues/17153 is an example of that awkward navigation language:

[...] as per the M_UNRECOGNIZED description at https://spec.matrix.org/v1.10/client-server-api/#common-error-codes