Skip to content
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.

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

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

Open
turt2live opened this issue May 3, 2024 · 1 comment
Open

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

turt2live opened this issue May 3, 2024 · 1 comment
Labels
clarification An area where the expected behaviour is understood, but the spec could do with being more explicit good first issue This is a fix that might be an easy place for someone to start for their first contribution

Comments

@turt2live
Copy link
Member

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 turt2live added clarification An area where the expected behaviour is understood, but the spec could do with being more explicit good first issue This is a fix that might be an easy place for someone to start for their first contribution labels May 3, 2024
@turt2live
Copy link
Member Author

element-hq/synapse#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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification An area where the expected behaviour is understood, but the spec could do with being more explicit good first issue This is a fix that might be an easy place for someone to start for their first contribution
Projects
None yet
Development

No branches or pull requests

1 participant