fix(client): serialize headers in APIError.toJSON() so rate-limit headers are visible#1837
Closed
anishesg wants to merge 1 commit intoopenai:masterfrom
Closed
fix(client): serialize headers in APIError.toJSON() so rate-limit headers are visible#1837anishesg wants to merge 1 commit intoopenai:masterfrom
anishesg wants to merge 1 commit intoopenai:masterfrom
Conversation
…ders are visible - [x] I understand that this repository is auto-generated and my pull request may not be merged Signed-off-by: anish k <ak8686@princeton.edu>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: be7d8baeea
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Author
|
Closing — auto-generated SDK repo. The team regenerates from API specs so external PRs rarely land. |
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.
Changes being requested
When a 429 (or any non-2xx) response is received, the SDK throws an
APIErrorwhoseheadersproperty is a nativeHeadersinstance. BecauseHeadershas notoJSONmethod, callingJSON.stringify(error)produces"headers": {}, hiding all headers — including thex-ratelimit-reset-requests,x-ratelimit-reset-tokens, and related headers developers need for custom retry logic.The fix adds a
toJSON()method toAPIErrorinsrc/core/error.tsthat convertsthis.headersto a plain object viaObject.fromEntries(this.headers.entries()). Theheadersinstance itself is unchanged, soerror.headers.get('x-ratelimit-reset-requests')continues to work as before; the change only affects serialisation.Additional context & links
Fixes #1477