Sanity Library Reference Docs
    Preparing search index...

    Type Alias WorkflowDeploymentInput

    WorkflowDeploymentInput: Omit<
        WorkflowDeployment,
        "expectedMinReaderModel"
        | "partition",
    > & { expectedMinReaderModel: number; partition?: string; tag?: string }

    Author one deployment with a nonempty definitions array and a WorkflowResource. Dataset resource IDs use <projectId>.<dataset>.

    name and partition must contain only ASCII lowercase letters, digits, and dashes, starting with a letter or digit. Deployment names and (workflowResource, partition) pairs must be unique across the config. Omit partition only when this is the sole deployment on its configured resource; it resolves to default. Optional resourceAliases use the same name grammar, with unique names within this deployment.

    expectedMinReaderModel is the highest reader model you have verified across runtimes sharing the workflow resource. Supply a reviewed numeric literal. Definition submission checks it against the required reader floor; upgrading a dependency alone does not require changing it.

    runtime is the default hosting kind for this deployment's workflows, which each workflow and effect may override. Omitted, its workflows host on 'function'.

    Type declaration

    • expectedMinReaderModel: number
    • Optionalpartition?: string
    • Optionaltag?: string

      Rename to partition and keep the same value.