Skip to content

Updated json schema documentation#372

Merged
Mystypix merged 2 commits intomainfrom
mystypix-ut-3614-json-schema-updates
Mar 30, 2026
Merged

Updated json schema documentation#372
Mystypix merged 2 commits intomainfrom
mystypix-ut-3614-json-schema-updates

Conversation

@Mystypix
Copy link
Copy Markdown
Contributor

Linear: UT-3614

Changes:

  • Updated json schema UI documentation

@Mystypix Mystypix self-assigned this Mar 18, 2026
@linear
Copy link
Copy Markdown

linear bot commented Mar 18, 2026

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the component configuration schema documentation to reflect the current RJSF-based form rendering and expands the UI options/examples reference for common UI patterns (conditional visibility, layout, and informational blocks).

Changes:

  • Replaces legacy JSON Editor references with RJSF and adds concise “Supported Formats” / “Supported Options” reference tables.
  • Extends UI element examples with nested options.dependencies, radio buttons, date picker, grid layout, collapsible sections, disabled fields, and info blocks.
  • Documents deprecated legacy JSON Editor features (enumSource / watch) and points to options.async alternatives.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
extend/component/ui-options/ui-examples/configuration-schema-examples.md Adds/clarifies examples for conditional visibility and additional UI formats (radio/date/grid/info, etc.).
extend/component/ui-options/configuration-schema.md Updates top-level schema docs to RJSF and adds supported formats/options reference + deprecated legacy features note.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@Mystypix Mystypix marked this pull request as ready for review March 26, 2026 13:11
@Mystypix Mystypix requested a review from natocTo March 26, 2026 15:14
- Remove `format: "select"` from formats table (not a distinct format)
- Add `options.documentation` to supported options (link icon with tooltip)
- Note that `options.tooltip` supports Markdown
- Fix `enumSource`/`watch` — NOT deprecated, still supported (moved to Legacy)
- Mark `links` as deprecated (not supported in RJSF), suggest `options.documentation`
- Add examples for tooltips and documentation links
- Add `options.documentation` migration example in Links section

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Mystypix Mystypix force-pushed the mystypix-ut-3614-json-schema-updates branch from 48bb81d to b11460f Compare March 26, 2026 15:16
@Mystypix Mystypix merged commit bfed6a4 into main Mar 30, 2026
1 check passed
@Mystypix Mystypix deleted the mystypix-ut-3614-json-schema-updates branch March 30, 2026 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants