Document the standard Rate Limit headers that the SDK implements
Open
Nobody has claimed this yet.
documentation
- Dominant language
- TypeScript
- Stars
- 51
- Forks
- 105
- Avg merge
- 10h 35m
- Merged PRs (30d)
- 17
Description
Currently the SDKs expect:
X-RateLimit-Limit: The maximum number of requests in a time period.X-RateLimit-Remaining: The number of requests remaining in the current rate limit window.X-RateLimit-Reset: the time at which the current rate limit window resets in UTC epoch seconds"
We're also considering support for Retry-After
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 by locating the SDK documentation that describes rate limiting and compare it with the three headers listed in the issue. Document their meanings and confirm whether Retry-After is implemented before including it; done means the supported headers and any limitation around Retry-After are clearly stated.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100