Repository navigation
Pipecat Cloud API: update the validation error example - #1630
Merged
Merged
Conversation
A 400 validation issue now has code invalid_value and lists its options under values, and no longer has a received field. Its path and message are unchanged.
Contributor
|
🔍 Mintlify preview for this branch: https://daily-openapi-validation-error-example.mintlify.site |
cbrianhill
approved these changes
Nov 3, 2026
cbrianhill
left a comment
There was a problem hiding this comment.
Claude Code contributed to this review.
Recommended comment; Brian approved. The updated field names match what the API returns after the validation-library upgrade, so nothing in the content needs changing; the one open item is that the requested merge hold is not enforced by anything.
No findings.
Verified:
- The three renamed/removed fields and the unchanged
messagewording both check out against the API: zod 4.4.3'sinvalid_valueissue carriesvaluesand strips the offending input infinalizeIssue, whileapi/src/utils/zod3.tsrestores zod 3'sInvalid enum value. Expected ... received '...'text throughz.config({ customError }). - The
issues/namewrapper and the top-level"code": "400"survive the upgrade because the new handler builds them explicitly (api/src/utils/errors.ts:186-213, withGENERIC_BAD_REQUEST = '400'at line 79). zod 4 makesissuesnon-enumerable on the error object, so this only holds because the handler stopped serializing the error directly. - This is the only validation-error example in the docs repo; code search for
invalid_enum_value,ZodErrorandInvalid parameterseach returns this one file.
The description's field list matches what the new validation layer actually emits, including the removal of received, which zod 4 does not report unless input reporting is explicitly enabled.
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.
The 400 example on the Pipecat Cloud REST reference shows validation issue fields that change in the next API release, when the API moves to zod 4.
codebecomesinvalid_value,optionsbecomesvalues, andreceivedgoes away.path,message, and theissuesandnamewrapper.The new example is the real output of the API's validation for this
statusparameter.Please hold the merge until that API release is in production. Until then, the current example still matches what's live.