feat(api): Emit a Retry-After header on rate-limited 429 responses

Open
#688 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
78/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
api, backend

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

area/backend enhancement good first issue help wanted

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 lint and just test must pass; add or update tests for the change.
  • Documentation: Update docs/api.md, docs/openapi.yaml, docs/errors.md and 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.md and docs/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 lint and just test locally before pushing (see CONTRIBUTING.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 main and link it with Closes #<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, .env files 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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Octo-Protocol-org/Octo-Protocol

All issues in Octo-Protocol-org/Octo-Protocol

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.