diff --git a/.changeset/regenerate-ui-action-reference-doc.md b/.changeset/regenerate-ui-action-reference-doc.md new file mode 100644 index 000000000..d4835d668 --- /dev/null +++ b/.changeset/regenerate-ui-action-reference-doc.md @@ -0,0 +1,7 @@ +--- +--- + +docs(spec): regenerate the `ui/action` reference doc for the inline lookup +`reference` key. Generated output only — the release for this change is +declared by the `@objectstack/spec` changeset in #3406, so this PR itself +releases nothing. diff --git a/content/docs/references/ui/action.mdx b/content/docs/references/ui/action.mdx index 8b0d15621..d0e58c94b 100644 --- a/content/docs/references/ui/action.mdx +++ b/content/docs/references/ui/action.mdx @@ -35,7 +35,21 @@ params: [ inline when no matching object field exists. Inline values may also be -used alongside `field` to override individual properties. +used alongside `field` to override individual properties. A `lookup` / + +`master_detail` param declared this way MUST name its target object via + +`reference` — there is no field to inherit it from: + +```ts + +params: [ + +\{ name: 'inspector', label: 'Inspector', type: 'lookup', reference: 'sys_user' \}, + +] + +``` `name` is required unless `field` is provided (in which case it defaults @@ -153,6 +167,7 @@ const result = Action.parse(data); | **multiple** | `boolean` | optional | Allow multiple values (array value shape); mirrors FieldSchema.multiple. | | **accept** | `string[]` | optional | Accepted upload types (MIME types / extensions) for file/image params. | | **maxSize** | `integer` | optional | Max upload size in bytes for file/image params. | +| **reference** | `string` | optional | Reference target object for inline lookup/master_detail params; mirrors FieldSchema.reference. | | **defaultFromRow** | `boolean` | optional | | | **visible** | `string \| { dialect: Enum<'cel' \| 'cron' \| 'template'>; source?: string; ast?: any; meta?: object }` | optional | Param visibility predicate (CEL); omits the param when false. | | **requiresFeature** | `Enum<'twoFactor' \| 'passkeys' \| 'magicLink' \| 'organization' \| 'multiOrgEnabled' \| 'degradedTenancy' \| 'oidcProvider' \| 'sso' \| 'ssoEnforced' \| 'deviceAuthorization' \| 'admin' \| 'phoneNumber' \| 'phoneNumberOtp'>` | optional | Public auth feature flag gating this param; lowered into `visible` at parse time. |