Repository navigation
docs: add JSDoc for getScopesOfParsedJsonSchema - #2524
garv-sanveria wants to merge 2 commits into
Conversation
|
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! |
|
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! |
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 #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. 🚀 New features to boost your workflow:
|
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
getScopesOfParsedJsonSchemacurrently 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