matrix-org / matrix-org/matrix-spec
Consider having API deprecation headers on requests
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
When people are using old endpoints, they may not be aware that the endpoint they are using is N years old. Twitter uses an interesting approach in that they have an `x-api-warn` and similar headers on requests that clients are expected to log about. Having something similar could make some sense for matrix.
More information about Twitter's approach is here (under "Versioning Strategy"): https://developer.twitter.com/en/docs/ads/general/overview/versions.html
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the issue's linked Twitter Versioning Strategy, then review how the Matrix specification currently describes endpoint versioning and deprecation. A complete contribution would need an agreed proposal defining the deprecation headers, their meaning, and expected client behavior in the relevant specification sections.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100