docs(readme): document Retry-After 429 header (#324)#325
Merged
Conversation
#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: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #324.
Summary
Adds a bullet in the README's HTTP-conventions section for the
Retry-After429 response header exposed in #322, with the CORS rationale.Test plan
npm run lint && npm test— 782 passing (docs-only change).Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/