Skip to content

Commit 2c6f347

Browse files
authored
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).
1 parent 7182011 commit 2c6f347

2 files changed

Lines changed: 23 additions & 1 deletion

File tree

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
---
3+
4+
docs(spec): regenerate the `ui/action` reference doc for the inline lookup
5+
`reference` key. Generated output only — the release for this change is
6+
declared by the `@objectstack/spec` changeset in #3406, so this PR itself
7+
releases nothing.

content/docs/references/ui/action.mdx

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,21 @@ params: [
3535

3636
inline when no matching object field exists. Inline values may also be
3737

38-
used alongside `field` to override individual properties.
38+
used alongside `field` to override individual properties. A `lookup` /
39+
40+
`master_detail` param declared this way MUST name its target object via
41+
42+
`reference` — there is no field to inherit it from:
43+
44+
```ts
45+
46+
params: [
47+
48+
\{ name: 'inspector', label: 'Inspector', type: 'lookup', reference: 'sys_user' \},
49+
50+
]
51+
52+
```
3953

4054
`name` is required unless `field` is provided (in which case it defaults
4155

@@ -153,6 +167,7 @@ const result = Action.parse(data);
153167
| **multiple** | `boolean` | optional | Allow multiple values (array value shape); mirrors FieldSchema.multiple. |
154168
| **accept** | `string[]` | optional | Accepted upload types (MIME types / extensions) for file/image params. |
155169
| **maxSize** | `integer` | optional | Max upload size in bytes for file/image params. |
170+
| **reference** | `string` | optional | Reference target object for inline lookup/master_detail params; mirrors FieldSchema.reference. |
156171
| **defaultFromRow** | `boolean` | optional | |
157172
| **visible** | `string \| { dialect: Enum<'cel' \| 'cron' \| 'template'>; source?: string; ast?: any; meta?: object }` | optional | Param visibility predicate (CEL); omits the param when false. |
158173
| **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. |

0 commit comments

Comments
 (0)