IValidation.IError.description filling about undefined cases.
#198
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
This pull request enhances error reporting in the OpenAPI validation utilities by adding detailed descriptions to validation errors. The changes provide more informative error messages to help developers understand and resolve validation issues, particularly for undefined values and undefined properties.
Key changes:
- Enhanced error object creation to include description fields with contextual guidance
- Added specific handling for undefined values with helpful developer instructions
- Provided clear messaging for undefined properties with removal guidance
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/utils/OpenApiValidator.ts |
Enhanced error object creation with description field and special handling for undefined values |
src/utils/internal/OpenApiObjectValidator.ts |
Added description field for undefined property errors with specific removal guidance |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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 error reporting in the OpenAPI validation utilities by adding detailed descriptions to validation errors. These changes improve the clarity of error messages, making it easier for developers to understand and resolve issues.
Enhancements to error reporting:
src/utils/OpenApiValidator.ts: Updated the error object to include adescriptionfield. If the error'svalueisundefined, a default description is added to guide developers on how to address the issue.src/utils/internal/OpenApiObjectValidator.ts: Added adescriptionfield to the error object for undefined properties, providing specific guidance to remove the property from the object.