Skip to content

submitBehavior's source JSDoc still claims thank-you (default), which the #7245 ruling makes false on the internal path #7441

Description

@os-help

Flagged by the dev implementing #7245's docs half (PR #7417) and left unpatched because it is outside that card's pinned file surface.

Measured

packages/spec/src/ui/view.zod.ts (~line 2029), the JSDoc above submitBehavior, still reads:

thank-you (default) — show a confirmation panel

The maintainer's 2026-08-10 ruling on #7245 makes that mode-dependent: thank-you stays the default for the public/console/f/:slug path only, while the internal/console/forms/:name path (where type: 'form' actions send operators) defaults to redirecting to the created record.

Why it is worth a card rather than nothing

The schema itself is correct and unchanged — submitBehavior is .optional() with no.default(), and its .describe() string is the neutral 'Post-submit behavior', which is why the generated content/docs/references/ui/view.mdx:269 reproduces nothing false. Only the source comment carries the stale claim, so nothing user-facing is wrong today.

It becomes wrong the moment the renderer half lands (objectui#4109), and a source comment is exactly where the next author reaches for the answer. Small, mechanical, and cheap now; a silent contradiction between contract and comment later.

Suggested fix

Make the JSDoc mode-aware, mirroring the contract now stated in content/docs/protocol/objectui/actions.mdx and content/docs/ui/forms.mdx (PR #7417): public path defaults to thank-you, internal path defaults to redirect-to-created-record, an explicit submitBehavior wins in either mode.

Refs: #7245 (the ruling) · #7417 (docs half, where the flag came from) · objectui#4109 (renderer half).

No domain:* label applied — routing is the triage seat's single-producer territory. (Landing site is packages/spec/src/** text, which reads as domain:spec-surface territory.)

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions