Skip to content

docs: add JSDoc for getScopesOfParsedJsonSchema #2524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
garv-sanveria wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add JSDoc for getScopesOfParsedJsonSchema #2524

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
533a07f
docs: add JSDoc for getScopesOfParsedJsonSchema
Sep 30, 2026
56bef88
style: fix prettier spaces
Sep 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion lib/getScopesOfParsedJsonSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,15 @@ export type JsonSchemaPathWithScope = {
jsonPath: string;
scope: JsonSchemaScope;
};

/**
* Recursively parses a JSON Schema to map JSON paths to their corresponding scope types.
* This is primarily used to bind interactive UI elements to specific schema definitions
* in the schema editor.
*
* @param parsedJsonSchema - The parsed JSON Schema object or sub-schema.
* @param jsonPath - The current JSON path prefix (defaults to the root '$').
* @returns An array of objects mapping the calculated JSON paths to their scopes.
*/
export default function getScopesOfParsedJsonSchema(
parsedJsonSchema: any,
jsonPath = '$',
Expand Down
Loading