Sanity Library Reference Docs
    Preparing search index...
    • Validate a deploy config — the binding of each definition's logical resource handles to physical resources, per environment (partition). Throws a formatted, path-prefixed error if the shape is invalid.

      Every returned deployment carries partition, 'default' when omitted. A deployment that shares its workflowResource with another must set partition. A deprecated tag is accepted as the partition and adds a deprecation message to warnings, which this function never prints; a tag that is not a string, is not a valid partition, or disagrees with partition throws. Passing a returned config back in keeps its warnings. The CLI collapses the selected deployment's bindings via resourceAliasesToMap into the resourceAliases map deployDefinitions expands against.

      Validates shape only; reader-floor acknowledgement belongs to paths that submit definitions (deployDefinitions, the CLI deploy and definition-diff commands, and blueprint provision). Other commands may load a selected deployment with a missing floor.

      Each WorkflowDeploymentInput carries an acknowledgement; definition-submission paths compare it with the submitted definitions. The returned WorkflowConfig is the looser parsed shape.

      Parameters

      Returns WorkflowConfig