docs(spec): correct ReportChart xAxis/yAxis semantics; mark dead report surface (#1890)#3441
Merged
Merged
Conversation
…rt surface (#1890) Closes the report residual of the ADR-0021 analytics migration. The dataset-bound report chart already renders (objectui DatasetReportRenderer plots chart.xAxis/yAxis as the bound dataset's dimension/measure via useDatasetRows; Studio ReportDefaultInspector picks them from the dataset catalogs), but the spec describe() still called them raw fields. - ReportChart.xAxis/yAxis describe now states dataset dimension/measure names. - ReportChart.groupBy marked [EXPERIMENTAL — not enforced] (dataset renderer never reads it; only the legacy ReportViewer fallback did). - ReportColumnSchema/ReportGroupingSchema marked @deprecated — unreferenced by the single-form report shape; kept only as public type exports pending a governed prune. Docs regenerated. No shape/parse-behavior change; no export removed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CMaDBhnZEUu1fcw8Rvo6Yq
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
documentation
Contributor
📓 Docs Drift CheckThis PR changes 1 package(s): 104 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:
|
os-zhuang
marked this pull request as ready for review
July 24, 2026 15:07
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
2 participants
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
Closes the report residual of the ADR-0021 analytics migration (#1890,
umbrella #1878). Investigation overturned the audit's premise: the dataset-bound
report chart is not un-migrated — objectui's
DatasetReportRendereralreadyplots
chart.xAxis/yAxisas the bound dataset's dimension/measure viauseDatasetRows, and the StudioReportDefaultInspectorsources them from thedataset's dimension/measure catalogs. The old
ReportViewer(legacyxAxisField/yAxisFields) is only a fallback.The genuine leftovers were spec-accuracy, not a renderer migration:
ReportChart.xAxis/yAxis—.describe()still said raw "Grouping field" /"Summary field", which misleads an author/AI into naming object fields instead of
the dataset dimension/measure names the renderer requires. Corrected.
ReportChart.groupBy— marked[EXPERIMENTAL — not enforced]: thedataset renderer plots a single
xAxis×yAxisseries and never reads it.ReportColumnSchema/ReportGroupingSchema— marked@deprecated:unreferenced by the single-form report shape (columns/grouping are dataset
measure/dimension name arrays). Left in place (breaking to remove — objectui
re-exports them as
SpecReportColumn/SpecReportGrouping); flagged for afuture governed prune.
Testing
check:spec-changesgreen;tsc --noEmitgreen;gen:api-surfacereproduces the checked-in snapshot (no export removed).ui/report.mdx).Note for maintainers
The deeper disposition — enrolling
reportin the livenessGOVERNEDset (it'sregistered/authorable but not yet governed, so no ledger), and pruning the
ReportColumn/ReportGroupingexports + retiring the legacyReportViewer— isleft as a follow-up; this PR is the non-breaking accuracy fix.
Part of umbrella #1878.
🤖 Generated with Claude Code
Generated by Claude Code