docs(spec): regenerate ui/action reference for inline lookup reference (fixes #3406 CI)#3410
Merged
os-zhuang merged 2 commits intoJul 22, 2026
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
documentation
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
marked this pull request as ready for review
July 22, 2026 20:27
os-zhuang
merged commit Jul 22, 2026
2c6f347
into
fix/action-param-inline-lookup-3405
4 of 5 checks passed
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>
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
Regenerates the generated reference doc
content/docs/references/ui/action.mdxso it reflects the newreferencekey added toActionParamSchemain #3406.Why
#3406 added
referencetoActionParamSchema(and a.refine()requiring it on inlinelookup/master_detailparams) but did not regenerate the derived docs. The TypeScript Type Check job'scheck:docsstep (pnpm gen:schema && tsx scripts/build-docs.ts --check) therefore failed:These files are generated — do not hand-edit — so the fix is to run the generator and commit the result.
Change
pnpm --filter @objectstack/spec gen:schema && pnpm --filter @objectstack/spec gen:docs.content/docs/references/ui/action.mdxchanged: the new inline-lookup prose block and areferencerow in the params table. JSON-schema output underpackages/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-3405turns #3406's CI green.🤖 Generated with Claude Code
Generated by Claude Code