Skip to content

docs(spec): regenerate ui/action reference for inline lookup reference (fixes #3406 CI) - #3410

Merged
os-zhuang merged 2 commits into
fix/action-param-inline-lookup-3405from
claude/pr-3406-fix-9wjhmx
Jul 22, 2026
Merged

docs(spec): regenerate ui/action reference for inline lookup reference (fixes #3406 CI)#3410
os-zhuang merged 2 commits into
fix/action-param-inline-lookup-3405from
claude/pr-3406-fix-9wjhmx

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

What

Regenerates the generated reference doc content/docs/references/ui/action.mdx so it reflects the new reference key added to ActionParamSchema in #3406.

Why

#3406 added reference to ActionParamSchema (and a .refine() requiring it on inline lookup/master_detail params) but did not regenerate the derived docs. The TypeScript Type Check job's check:docs step (pnpm gen:schema && tsx scripts/build-docs.ts --check) therefore failed:

✗ content/docs/references/ui/action.mdx (out of date)

These files are generated — do not hand-edit — so the fix is to run the generator and commit the result.

Change

  • Ran pnpm --filter @objectstack/spec gen:schema && pnpm --filter @objectstack/spec gen:docs.
  • Only content/docs/references/ui/action.mdx changed: the new inline-lookup prose block and a reference row in the params table. JSON-schema output under packages/spec/json-schema/ is gitignored, so nothing else needed committing.

Verification

  • pnpm --filter @objectstack/spec check:docs✅ 254 generated files in sync with packages/spec (exit 0), the exact step that was failing.
  • pnpm --filter @objectstack/spec test → 256 files / 6822 tests pass.

Merging this into fix/action-param-inline-lookup-3405 turns #3406's CI green.

🤖 Generated with Claude Code


Generated by Claude Code

The generated `content/docs/references/ui/action.mdx` was left out of date
when `reference` was added to `ActionParamSchema`, failing the `check:docs`
CI step. Regenerated via `gen:schema && gen:docs`; only the generated doc
changes (JSON schema output is gitignored).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011W4a1eVS3aaYVRxKut68hK
@vercel

vercelBot commented Jul 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
specReadyReadyPreview, CommentJul 22, 2026 8:33pm

Request Review

@github-actionsgithub-actionsBot added documentation Improvements or additions to documentation size/s labels Jul 22, 2026
The `ui/action` reference doc regeneration is generated output and releases
nothing on its own — the `@objectstack/spec` release is declared by the
changeset in #3406. This empty-frontmatter changeset satisfies the
"Check Changeset" gate, which diffs added .changeset files against this PR's
base (the #3406 head) and otherwise sees none.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011W4a1eVS3aaYVRxKut68hK
@os-zhuang
os-zhuang marked this pull request as ready for review July 22, 2026 20:27
@os-zhuang
os-zhuang merged commit 2c6f347 into fix/action-param-inline-lookup-3405Jul 22, 2026
4 of 5 checks passed
@os-zhuang
os-zhuang deleted the claude/pr-3406-fix-9wjhmx branch July 22, 2026 20:27
os-zhuang added a commit that referenced this pull request Jul 22, 2026
… target (#3405) (#3406)
* feat(spec): let an inline `lookup` action param declare its reference target (#3405)
`ActionParamSchema` had no way to name the object an inline record-picker param
should search. Authors reasonably wrote the same key the field schema uses —
`{ name: 'inspector', type: 'lookup', reference: 'sys_user' }` — and the schema
stripped it as an unknown key, silently. Downstream the param dialog saw a
picker with no target and degraded it to a "paste the record id (UUID)" text
input, so the authored intent was dropped and the user was handed a control a
human cannot reasonably operate (found on a QC dispatch assign/transfer action).
- Added `reference` to `ActionParamSchema`, spelled to match
`FieldSchema.reference` so one spelling works in both places. It joins the
existing inline widget config (`multiple` / `accept` / `maxSize`), which had
covered the file/image params but not the picker ones.
- A `lookup` / `master_detail` param declared inline with no `reference` is now
a parse-time error pointing at the missing key, instead of degrading at
render time. Field-backed params are unaffected: they inherit the target from
the referenced field's metadata, which is not visible at parse time.
- app-showcase's action-param gallery gains the inline picker specimen it could
not previously express, next to the other widget types.
Verified: `objectstack validate` on app-showcase fails with the new message when
`reference` is removed and passes with it, and the param renders a working
searchable picker in the console (see objectui's companion change).
Refs #3405
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* docs(spec): regenerate ui/action reference for inline lookup `reference` (#3410)
Regenerates content/docs/references/ui/action.mdx so it reflects the new
`reference` key on ActionParamSchema, fixing the check:docs CI step on #3406.
Includes an empty changeset (docs-only regeneration releases nothing).
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: os-zhuang <jack@objectstack.ai>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationsize/stooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@os-zhuang@claude