feat(api): Emit a Retry-After header on rate-limited 429 responses
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 78/100
Research direction
Start with crates/api/src/rate_limit.rs and crates/api/src/error.rs to trace how rate limits become 429 responses and where the remaining window is available. Add an integration test that exceeds a limit and checks for a positive integer Retry-After value. Update docs/api.md, docs/openapi.yaml, docs/errors.md, and the changelog; done when the response and docs describe the header and the test passes.
Written by the indexing model from the issue text.
Description
Description
The rate limiter returns TooManyRequests with a message only. A standard Retry-After header lets well-behaved clients back off correctly.
Requirements and context
- Where:
crates/api/src/rate_limit.rs,crates/api/src/error.rs,docs/api.md - Security: Follow
docs/threat-model.md; no secrets, tokens or personal data in code, logs, tests or commit messages. - Testing:
just fmt-check,just lintandjust testmust pass; add or update tests for the change. - Documentation: Update
docs/api.md,docs/openapi.yaml,docs/errors.mdand add a CHANGELOG entry.
Suggested execution
- Comment on this issue to claim it, then fork the repository and branch from
main. - Branch name:
git checkout -b feat/api-retry-after-header
Implement changes
- Carry the remaining window (seconds) in the 429 error path.
- Add
Retry-After: <seconds>when building the response. - Document the header in
docs/api.mdanddocs/openapi.yaml.
Test and commit
- Add an integration test that exceeds a limit and asserts the header is a positive integer.
- Run
just fmt,just lintandjust testlocally before pushing (seeCONTRIBUTING.md). - Commit with a conventional message and keep the change small and focused.
Example commit message
feat(api): add Retry-After to 429 responses
Guidelines
- Open the PR against
mainand link it withCloses #<this issue>. - Keep the diff focused on this issue; no unrelated refactors or formatting churn.
- One line per comment, no bloated code; follow patterns already used in the crate.
- Never commit secrets,
.envfiles or real keys; use public test vectors only. - CI (fmt, clippy
-D warnings, tests) must be green before requesting review. - Ask in the issue thread if anything is unclear before starting.
- Dominant language
- Rust
- Stars
- 0
- Forks
- 91
- Avg merge
- 5h 23m
- Merged PRs (30d)
- 4
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from Octo-Protocol-org/Octo-Protocol
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Octo-Protocol-org/Octo-Protocol#701 · 1 comment ·
All issues in Octo-Protocol-org/Octo-Protocol
Similar issues
-
needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
pbakaus/impeccable#1601 ·
Maintainers usually reply within 1 day
-
RDF/XML writer: a blank node in two lists is left out of the secondPossibly taken @mrnolte claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
phillord/horned-owl#368 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
mongodb/kingfisher#588 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
bug rust
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 2 days