Bugfix and refactoring of the JSON Schema scope detection logic in th…#2308
Open
Adityakk9031 wants to merge 1 commit intojson-schema-org:mainfrom
Open
Bugfix and refactoring of the JSON Schema scope detection logic in th…#2308Adityakk9031 wants to merge 1 commit intojson-schema-org:mainfrom
Adityakk9031 wants to merge 1 commit intojson-schema-org:mainfrom
Conversation
…e JsonEditor component.
|
Hi @Adityakk9031! Thanks a lot for your contribution! I noticed that the following required information is missing or incomplete: completed checklist items Please update the PR description to include this information. You can find placeholders in the PR template for these items. Thanks a lot! |
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2308 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 30 30
Lines 672 672
Branches 211 211
=========================================
Hits 672 672 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Author
|
@Utkarsh-123github and @jagpreetrahi please have a look |
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
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.
What kind of change does this PR introduce?
Bugfix and refactoring of the schema scope detection logic in the JsonEditor component.
Issue Number:
Screenshots/videos:
Before: Keywords like
type,itemsinside$defsblocks render in cyan (plain data) and are not clickable.After: The same keywords render in interactive blue and link to reference docs, matching the behaviour inside
propertiesblocks.If relevant, did you update the documentation?
N/A — this change improves the interactive behaviour of the documentation's built-in JSON editor. No content docs needed updating.
Summary
getScopesOfParsedJsonSchema.ts previously gated subschema recursion on
parsedJsonSchema.type === 'object'or=== 'array', only traversingproperties,patternProperties, and single-formitems. JSON Schema doesn't require atypefield, so any schema without it (e.g.{ "$defs": { ... } }) caused the function to return early — leaving all nested keywords non-interactive.This PR replaces the type-gated logic with a keyword-driven traversal across all three subschema-bearing keyword categories from the spec:
$defs,definitions,properties,patternProperties,dependentSchemas)allOf,anyOf,oneOf,prefixItems)not,if,then,else,additionalProperties,propertyNames,unevaluatedProperties,additionalItems,unevaluatedItems,items)Boolean subschemas (e.g.
additionalProperties: false) are also now handled correctly.Closes #2259
Does this PR introduce a breaking change?
No. This is purely additive — all previously recognised scope paths continue to be emitted as before. The fix only adds scope paths for keywords that were previously missed.
Checklist
Please ensure the following tasks are completed before submitting this pull request.