docs(openapi): align Error schema with the runtime body shape (#336)#337
Merged
Conversation
The OpenAPI Error component schema declared an `error: string` field that no controller and no middleware ever emits — the project's no-leak policy (pinned by tests/unit/controller-error-shape.test.js) explicitly forbids echoing raw error detail back to the client. Conversely the global error handler in `app/middleware/error-handler.js` does emit `requestId` when the request reached the request-id middleware (and every server-internal 500 response body carries it for log correlation), but the schema never named the field. Net effect: SDK code-gen consuming the spec built client types with a phantom `error` field while missing the real `requestId` field — both wrong directions of drift at once. Replace the bogus `error` property with the real `requestId` one, keep `message` as the only required field, and pin the new shape with a test in tests/api/openapi.test.js. 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 #336.
Summary
Drops the phantom
error: stringfield (never emitted) and adds the realrequestIdfield (emitted by the global error handler for log correlation). Keepsmessageas the only required field.Test plan
npm run lint && npm test— 785 passing (was 784).Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/