Skip to content

Commit 9d511c8

Browse files
CryptoJonesAaron K. Clarkclaude
authored
docs(readme): mention Retry-After 429 header alongside RateLimit-* (#325)
#322 exposed `Retry-After` on cross-origin 429 responses so browser JS could honor the server's back-off instead of falling back to a fixed-delay retry. The README's "HTTP conventions" section listed the RateLimit-* trio but never mentioned Retry-After, so SDK authors reading the doc wouldn't know the field was available. Add a bullet describing the header, what it means, and the CORS exposure rationale (Retry-After is NOT on the CORS safelisted- response-headers set, so the project's expose-headers list is what makes it readable cross-origin). Co-authored-by: Aaron K. Clark <akclark@thenetwerk.net> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 9a45159 commit 9d511c8

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,11 @@ Working example at [node.timetrackerapi.com](http://node.timetrackerapi.com).
6666
propagate trace context from a reverse proxy / mesh.
6767
- **`RateLimit-*` (response headers, RFC standard)**`RateLimit-Limit`,
6868
`RateLimit-Remaining`, `RateLimit-Reset` on every /v1/* response.
69+
- **`Retry-After` (response header on 429, RFC 7231)** — seconds the
70+
client should wait before retrying when the quota is exhausted.
71+
Cross-origin browser JS can read this via the CORS expose-headers
72+
list (it's not on the CORS safelist) so SDKs can honor the server's
73+
back-off instead of falling back to a fixed-delay retry.
6974
- Browser JS reading any of the above on a cross-origin response works
7075
out-of-the-box: the CORS layer's `Access-Control-Expose-Headers` covers them.
7176

0 commit comments

Comments
 (0)