Skip to content

docs: add JSDoc for getScopesOfParsedJsonSchema - #2524

Open
garv-sanveria wants to merge 2 commits into
json-schema-org:mainfrom
garv-sanveria:docs/schema-scopes-jsdoc
Open

garv-sanveria wants to merge 2 commits into
json-schema-org:mainfrom
garv-sanveria:docs/schema-scopes-jsdoc

Conversation

@garv-sanveria

@garv-sanveria garv-sanveria commented Sep 30, 2026 •

Copy link
Copy Markdown

What kind of change does this PR introduce?
Documentation

**Issue Number:**Fixes #2496

Screenshots/videos:
N/A

If relevant, did you update the documentation?
Yes, this PR adds documentation directly to the source code.

Summary
The core utility function getScopesOfParsedJsonSchema currently lacks documentation, making it difficult for new contributors to understand its purpose, parameters, and return type.

This PR adds a comprehensive JSDoc comment explaining that the function recursively parses a JSON Schema to map JSON paths to scope types for the interactive schema editor UI.

Does this PR introduce a breaking change?
No

Checklist

  • Read, understood, and followed the contributing guidelines.

@github-actions

Copy link
Copy Markdown

Hi @garv-sanveria! Thanks a lot for your contribution!

I noticed that the following required information is missing or incomplete: issue reference

Please update the PR description to include this information. You can find placeholders in the PR template for these items.

Thanks a lot!

@github-actions

Copy link
Copy Markdown

Hi @garv-sanveria! Thanks a lot for your contribution!

I noticed that the following required information is missing or incomplete: issue reference

Please update the PR description to include this information. You can find placeholders in the PR template for these items.

Thanks a lot!

@github-actions

github-actions Bot commented Sep 30, 2026 •

Copy link
Copy Markdown
built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
website ✅ Ready (View Log) Visit Preview 56bef88

@codecov

codecov Bot commented Sep 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (7b8104b) to head (56bef88).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #2524   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           31        31           
  Lines          695       695           
  Branches       215       215           
=========================================
  Hits           695       695           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

This branch was successfully deployed

1 active deployment
Preview — 56bef880 Deployed Sep 30, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Ready to review

Development

Successfully merging this pull request may close these issues.

Tuple items are not scoped in the interactive schema editor

1 participant