fix(api): align API error response contract#3308
Draft
aofei wants to merge 2 commits into
Draft
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Use `getApiStringLength` for frontend checks tied to OpenAPI `minLength` and `maxLength` constraints so Unicode input is accepted or rejected with the same semantics as the API contract. Move remaining shared limits into API modules, remove native `maxlength` enforcement where it would count UTF-16 code units, and apply code point budgets to Copilot and AI description payloads. Document the frontend validation rule for future API inputs. Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
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, client-auth challenges, and the mixed `APIError` and `OAuthError` shape for identity provider form-post callback failures. 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>
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.
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, client-auth challenges, and the mixedAPIErrorandOAuthErrorshape for identity provider form-post callback failures.Decode OAuth error payloads in the frontend client and keep retry metadata handling aligned with documented backend error responses.