fix(api): align API error response contract#3308
Merged
Merged
Conversation
Contributor
|
An internal error occurred. Please try again later. |
nighca
reviewed
Jul 6, 2026
Document the shared REST error envelope, stable error code catalog, and reusable response components so clients can decode API failures consistently. Document OAuth protocol error responses separately from `APIError`, including no-store headers and client-auth challenges, while keeping identity provider form-post callback failures on the shared API error envelope. Decode OAuth error payloads in the frontend client and keep retry metadata handling aligned with documented backend error responses. Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
nighca
approved these changes
Jul 6, 2026
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
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.
Document the shared REST error envelope, stable error code catalog, and reusable response components so clients can decode API failures consistently.
Document OAuth protocol error responses separately from
APIError, including no-store headers and client-auth challenges, while keeping identity provider form-post callback failures on the shared API error envelope.Decode OAuth error payloads in the frontend client and keep retry metadata handling aligned with documented backend error responses.