matrix-org / matrix-org/matrix-spec
Clarify when exactly a 502 can be returned by the media download endpoint
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
**Link to problem area**: https://spec.matrix.org/v1.2/client-server-api/#get_matrixmediav3downloadservernamemediaid
**Issue**
Probably through use of an MSC, we should clarify that this error code only shows up when the server is acting as a proxy and not when it's serving from cache.
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 linked Matrix Client-Server API section for GET /_matrix/media/v3/download/{serverName}/{mediaId}. Review how the endpoint describes 502 responses and investigate whether an MSC is needed to distinguish proxying from serving cached media. Done means the specification clearly states when this error can be returned.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100