Exact description of IValidation.IError.value
#193
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
This PR refines the validation error API to better support undefined values, simplifies the OpenAPI validator logic, and updates test coverage by removing outdated tests and adding a discriminated-union validation scenario.
- Support
undefinedinIValidation.IError.valueand improve its documentation. - Remove the
descriptionfield from error reports inOpenApiValidator. - Delete an obsolete test file and introduce a new test for discriminated-union validation.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/structures/IValidation.ts | Changed value type to unknown and enhanced doc comments with examples. |
| src/utils/OpenApiValidator.ts | Removed description from reported errors to simplify the validation output. |
| test/src/executable/validate.ts | Deleted outdated test for OpenApiTypeChecker and ClaudeSchemaComposer. |
| test/src/executable/discriminate.ts | Added a new test case for discriminated-union validation using typia. |
Comments suppressed due to low confidence (4)
src/utils/OpenApiValidator.ts:57
- Removing the
descriptionfield from reported errors may break consumers relying on human-readable messages; consider updating the interface or documentation to reflect this change and migrate consumers accordingly.
value: error.value,
src/structures/IValidation.ts:178
- Changing
valuefromanytounknowntightens the error API and may cause consumer code to require additional type assertions or checks; consider documenting upgrade steps or providing helper functions to ease migration.
value: unknown;
test/src/executable/discriminate.ts:14
- [nitpick] This test logs validation results but lacks assertions; consider replacing
console.logwith explicit assertions (e.g.,expectstatements) to automatically verify expected failures in CI.
console.log(result);
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 introduces improvements to validation handling, refactors error reporting, and updates test cases to align with the new validation logic. The most important changes include enhancements to the
IValidationnamespace, removal of unused code, and the addition of new test cases for validation scenarios.Enhancements to validation handling:
IValidation.IError.valuefield to supportundefinedvalues for more precise error reporting in cases of missing required properties or null/undefined validation scenarios. This improves the flexibility and accuracy of validation feedback. (src/structures/IValidation.ts, [1] [2]src/structures/IValidation.ts, src/structures/IValidation.tsR142-R147)Refactoring:
descriptionfield from error mapping inOpenApiValidator, simplifying the error reporting logic. (src/utils/OpenApiValidator.ts, src/utils/OpenApiValidator.tsL58)Updates to test cases:
discriminate.tsto validate schemas usingOpenApiValidatorandtypia, including validation of discriminated union types (ICatandIAnt). (test/src/executable/discriminate.ts, test/src/executable/discriminate.tsR1-R33)validate.tsthat usedOpenApiTypeCheckerandClaudeSchemaComposer, as it is no longer relevant to the updated validation logic. (test/src/executable/validate.ts, test/src/executable/validate.tsL1-L245)