429 responses should carry more information
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 597
- Forks
- 176
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 6
Description
Very hard to determine how you overloaded the server when you get a 429.
My suggestion is that the content or headers of the response should carry the expected rate of consumption for that API. At least add the limits to the documentation for each API.
Contributor guide
No contributing guide indexed for this repository
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 by reviewing the API's existing 429 response behavior and rate-limit documentation. Determine whether the expected consumption limits belong in response headers, response content, or per-API documentation; done means users can identify how they exceeded the limit and find the applicable limits.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100