chore: formalize validation error issues field (#3059)#3367
Closed
SkeletonMan2k21 wants to merge 1 commit into
Closed
chore: formalize validation error issues field (#3059)#3367SkeletonMan2k21 wants to merge 1 commit into
SkeletonMan2k21 wants to merge 1 commit into
Conversation
Contributor
|
Thanks for the careful work here — the plan doc shows the right shape of analysis and most of your resolved-decisions list matches where the spec landed. Heads up: this was superseded by #3562, which merged 2026-04-29 and closed #3059. A few places where #3562 made different calls worth knowing about for future PRs in this area:
Also independent of all that: Closing this one out. Appreciate the writeup either way. |
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.
Summary
Adds
issues[]to the core error schema as a formal optional field for structured validation errors.This formalizes behavior that could already appear as an extension and aligns the schema with current buyer-facing guidance, while preserving compatibility for existing consumers.
Approach
The change is additive and compatibility-focused:
issues[]is optionalfieldremains present for existing consumersissues[].pointeruses JSON Pointer format, matching current documented guidanceissues[].keywordis optional so implementations are not forced to invent placeholder valuesissues[].schemaPathis optional debug metadata, with guidance against exposing it in production responses by defaultRationale
Because the error schema already allowed additional properties,
issues[]could already appear as an extension. Defining it explicitly incore/error.jsonmakes that shape documented and interoperable for clients that want structured validation details.The goal is to standardize the schema contract, not redesign validation behavior.
Validation
Notes
Also updates buyer-facing docs/skill guidance and adds regression coverage for empty
issues[], optionalkeyword, compatibility offield, and non-normative issue extensions.