Add new property IValidation.IError.description
#191
Merged
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
There was a problem hiding this comment.
Pull Request Overview
Enhance validation error reporting by adding an optional human-readable description to IValidation.IError and ensuring it’s passed through in the OpenAPI validator.
- Introduce
description?: stringfield inIValidation.IErrorwith updated interface documentation. - Update
OpenApiValidatorto include the newdescriptionfield when constructing error objects.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/structures/IValidation.ts | Added description?: string to IError and expanded doc comments |
| src/utils/OpenApiValidator.ts | Propagated error.description into the returned validation error object |
Comments suppressed due to low confidence (2)
src/utils/OpenApiValidator.ts:58
- Add a unit or integration test to confirm that the
descriptionfield from the validation error is correctly propagated byOpenApiValidatorwhen provided.
description: error.description,
src/structures/IValidation.ts:162
- [nitpick] Consider adding a concrete example in the interface doc to illustrate when and how to provide the
descriptionfield, which can guide consumers in AI-driven scenarios.
* Optional human-readable description of the validation error
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.
This pull request enhances the validation error reporting in
IValidationand updates related functionality inOpenApiValidator. The changes aim to provide more comprehensive context for AI-driven validation processes by introducing a new optionaldescriptionfield and refining existing error attributes.Enhancements to validation error reporting:
src/structures/IValidation.ts: Added an optionaldescriptionfield to theIErrorinterface for human-readable explanations of validation errors. Updated thepathandexpectedattributes to use more precise and standardized formats, improving clarity and compatibility for AI function calling scenarios.Updates to error handling in OpenAPI validation:
src/utils/OpenApiValidator.ts: Modified the error handling logic to include the newdescriptionfield when processing validation errors, ensuring that additional context is passed through the validation pipeline.