BetaOptional BetaconditionalOptional BetaforceBy default, agent actions will never write to a published document.
Instead, they will force the use of a draft ID ("drafts.some-id") instead of the published ID ("some-id"), even when a published ID is provided.
Actions will use state from an existing draft if it exists, or use the published document to create a draft, if no draft exists.
Successful responses contains the _id that was mutated by the action.
When forcePublishedWrite: true an agent action will write to the exact id provided. The action will also not fallback to published state for draft ids.
When an ID on the form "versions.forcePublishedWrite: true.
That is, only the exact document state of the id provided is considered and mutated.
BetaschemaschemaId as reported by sanity deploy / sanity schema store
BetatargetTarget defines which parts of the document will be affected by the instruction. It can be an array, so multiple parts of the document can be separately configured in detail.
Omitting target implies that the document itself is the root.
Notes:
maxPathDepth
When a type or field in the schema has a function set for
hiddenorreadOnly, it is conditional.By default, Generate will not output to conditional
readOnlyandhiddenfields, ie, they are considered to resolve toreadOnly: true/hidden: true.conditionalPathsparam allows setting the default conditional value forhiddenandreadOnlyto false, or individually sethiddenandreadOnlystate for individual document paths.Note: fields and types with explicit readOnly: true or hidden: true in the schema, are not available to Generate, and cannot be changed via conditionalPaths
conditionalPaths state only apply to fields and types that have conditional
hiddenorreadOnlyin their schema definition.Consider using
hidden: () => truein schema config, if a field should be writeable only by Generate and never visible in the studio – then make the field visible to the Generate usingconditionalPaths.