Skip to content

finding(docs): core/report-schema.mdx names its subject ReportSchema — a name this tree does not declare, and one @objectstack/spec uses for a different thing #6171

Description

@yinlianghui-tw

Filed unassigned out of #6086 round 3, noticed while naming the shape on that page's property tables. The tables were named ReportComponentSchema in PR #6168; this is the surrounding prose, which is a different sentence and was left alone.

The fact

content/docs/core/report-schema.mdx calls its subject ReportSchema in three places:

  • frontmatter title: "Report Schema (ReportSchema)"
  • the H1 lead: "The ReportSchema enables creating comprehensive data reports…"
  • (the page's own example fence, by contrast, imports ReportComponentSchema)

ReportSchema resolves to nothing in this repo — not in @object-ui/types' built .d.ts, not in packages/*/src. The shape the page actually documents is ReportComponentSchema (packages/types/src/reports.ts:354), which is what its own example imports and what all four rows of its Basic Configuration table are members of.

Why it is worse than a typo

ReportSchema is not an unused name — @objectstack/specdoes export it, for the dataset-bound report shape shipped as json-schema/ui/Report.json (name / label / dataset / rows / columns / values / …). That is the shape content/docs/plugins/plugin-report.mdx documents, and it is a different thing from the type: 'report' component node this page is about. So a reader who follows the name lands on a real, wrong declaration rather than on nothing.

The two pages therefore use one name for two shapes, in the same docs tree.

Suggested resolution

Rename the subject on this page to ReportComponentSchema (title, H1 lead, and any other prose reference), which is what the page's own code already says. No source change.

Reproduce

head -12 content/docs/core/report-schema.mdx
grep -rn 'ReportComponentSchema' packages/types/src/reports.ts | head -3
ls node_modules/@objectstack/spec/json-schema/ui/Report.json

Refs: #6086 · PR #6168 (named the tables on this page) · #6155 (the same disease: one name, several shapes).

Metadata

Metadata

Labels

documentationImprovements or additions to documentationdomain:devxobjectui devx stream: fix lands on .github/, scripts/ or release pipeline — devx lane cross-repofindingpm:dispatched

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions