Repository navigation
fix(openapi): align error schema with nested error contract - #942
Closed
mopxam-art wants to merge 1 commit into
Closed
mopxam-art wants to merge 1 commit into
mopxam-art wants to merge 1 commit into
Conversation
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.
Why
src/lib/swagger.tsdefined the sharedErrorschema using the legacy flat shape{ error: string }. However, the documented standard across the backend runtime (src/middleware/errors.ts) is{ error: { code, message } }. Becauseopenapi.jsonandpackages/api-clientare generated from the spec, client consumers were typed to expect a flat string instead of the nested contract, breaking structured error handling.What
components.schemas.Errorinsrc/lib/swagger.tsto{ error: { code: string, message: string } }with required fields and descriptive examples.BadRequest,Unauthorized,Forbidden,NotFound,Conflict,TooManyRequests,InternalServerError) incomponents.responses.#/components/schemas/Error.openapi.jsonand regenerated typed client inpackages/api-client/src/types.ts.src/__tests__/openapi-contract.test.tsto assert the nested error contract.Verified
src/__tests__/openapi-error-schema.test.ts(107 passing) covering boundaries, status codes, operation mappings, invalid payload rejections, and sequential stress validations.npm test).npm run openapi:check) and typecheck (npx tsc --noEmit) clean with 0 errors.npm run api-client:build) and production build (npm run build) succeeded.Closes #925
Payout coordinate:
USDC (EVM / Base / Arbitrum / ERC20): 0x387c064ccf729a4846b62e95dc6b70e4d4c41e73