fix(property-case-convention): report correct path in errors #526
Conversation
This file contains 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
This commit modifies the "property-case-convention" rule slightly so that when it reports a problem with the case for a specific property, the offending property name will be included in the error message, and the path associated with the error will reflect the schema's "properties" field in which the offending property is defined. This subtle change will ensure that the spectral "unresolver" will not be overzealous when "unresolving" the path. Signed-off-by: Phil Adams <phil_adams@us.ibm.com>
ibm-devx-sdk
pushed a commit
that referenced
this pull request
Dec 14, 2022
## @ibm-cloud/openapi-ruleset [0.45.1](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/openapi-ruleset@0.45.0...@ibm-cloud/openapi-ruleset@0.45.1) (2022-12-14) ### Bug Fixes * **property-case-convention:** report correct path in errors ([#526](#526)) ([3fd84cf](3fd84cf))
|
🎉 This PR is included in version 0.45.1 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
ibm-devx-sdk
pushed a commit
that referenced
this pull request
Dec 14, 2022
## ibm-openapi-validator [0.97.1](https://github.com/IBM/openapi-validator/compare/ibm-openapi-validator@0.97.0...ibm-openapi-validator@0.97.1) (2022-12-14) ### Bug Fixes * **property-case-convention:** report correct path in errors ([#526](#526)) ([3fd84cf](3fd84cf)) ### Dependencies * **@ibm-cloud/openapi-ruleset:** upgraded to 0.45.1
|
🎉 This PR is included in version 0.97.1 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
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.
PR summary
This commit modifies the "property-case-convention" rule slightly so that when it reports a problem with the case for a specific property, the offending property name will be included in the error message, and the path associated with the error will reflect the schema's "properties" field in which the offending property is defined.
This subtle change will ensure that the spectral "unresolver" will not be overzealous when "unresolving" the path.
Signed-off-by: Phil Adams phil_adams@us.ibm.com
Background info on this PR can be found in the issue
PR Checklist
General checklist
Please make sure that your PR fulfills the following requirements:
Checklist for adding a new validation rule: