feat: ✨ exclude required issues at a given JSON path #138
+91
−9
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
martonvago
commented
Oct 16, 2025
lwjohnst86
requested changes
Oct 21, 2025
github-project-automation
bot
moved this from In Review
to In Progress
in Iteration planning
lwjohnst86
requested changes
Oct 21, 2025
lwjohnst86
requested changes
Oct 27, 2025
github-project-automation
bot
moved this from In Review
to In Progress
in Iteration planning
Co-authored-by: Luke W. Johnston <[email protected]>
…/check-datapackage into feat/excluding-required
martonvago
commented
Oct 28, 2025
Comment on lines
+124
to
+126
| def _get_array_parts(path_part: str) -> Optional[re.Match[str]]: | ||
| """Extract the name and index from a JSON path part representing an array.""" | ||
| return re.search(r"(\w+)\[(\d+)\]$", path_part) |
There was a problem hiding this comment.
Is this what you meant?
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.
Description
This PR adds some logic to handle excluding required issues at a given JSON path.
The main problem here comes down to the following:
Given
Exclude(type="required", jsonpath="$.resources[*].name")andIssue(type="required", jsonpath="$.resources[3].name"), how can I detect that$.resources[*].namematches$.resources[3].name? I cannot get all matches in the descriptor for$.resources[*].namebecause, when the field is missing, there will be none.One approach would be to decide it based on JSON path syntax. This will get thorny quite quickly and would be a partial reimplementation of
jsonpathanyway.Here, I went with the approach of taking
$.resources[3].nameand building an object that has this field:{"resources": [{}, {}, {}, {"name": {}}]}. It doesn't matter what the field contains, as long as it exists. Testing$.resources[*].nameon this object (usingjsonpath) works nicely.I initially thought this was very hacky, but I'm coming around to it. But if anyone has better ideas, don't hold back!
Closes #121
Needs an in-depth review.
Checklist
just run-all