interface
LiveValidationRequest
The unsaved form values and field paths sent for live server validation.
Request properties
| Property | Type | Description |
|---|---|---|
id | string | Optional for collections. Include a saved document ID to check an update; omit it for a new document. Global requests must not include id. |
data | Record< | Required. Unsaved document values. On updates, omitted fields retain their saved values; explicit null clears a value for the check. No defaults or save hooks are applied. |
fields | string[] | Required. Between 1 and 64 distinct document-root paths, such as "salePrice" or "variants.0.salePrice". Use the current row index in a repeated path; each requested field must have a live validator. |
embedded | LiveValidationEmbeddedScope[] | Optional. Up to eight detached embedded editor payloads, selected through Go-declared plugin metadata. The built-in admin supplies these for embedded forms. |
How it works
The REST request body is limited to 1 MiB. Requests evaluate one exact locale, selected through LiveValidationOptions. The server limits checks to five seconds.
Full signature
interface LiveValidationRequest { ... }