Document apiReferenceDiff

diff.apply

Apply a previously computed diff payload to the current document. The document fingerprint must match the diff base fingerprint. Omitted changeMode applies story content directly; explicit tracked mode governs all four story families (body, header/footer parts, footnotes, endnotes). Comments, styles, and numbering are always applied directly. Supported mixed full-diff payloads apply atomically across body, comments, styles, numbering, and header/footers. Unsupported/deferred families such as package-graph/media/hyperlink closure, settings/theme, and textboxes fail closed before mutation.

mutates documenttracked modeconditional
doc.diff.apply(…)

Expected result

Returns a DiffApplyResult with applied operation count and diagnostics.

Inputs

diffobjectrequired
Fields
version"sd-diff-payload/v1" | "sd-diff-payload/v2"required
engine"superdoc-v2"required
baseFingerprintstringrequired
targetFingerprintstringrequired
coverageobjectrequired
Fields
bodytruerequired
commentsbooleanrequired
stylesbooleanrequired
numberingbooleanrequired
headerFootersbooleanrequired
summaryobjectrequired
Fields
hasChangesbooleanrequired
changedComponents"body" | "comments" | "styles" | "numbering" | "headerFooters" | "parts"[]required
bodyobjectrequired
commentsobjectrequired
stylesobjectrequired
numberingobjectrequired
headerFootersobjectrequired
partsobjectrequired
payloadobjectrequired

Opaque engine-owned diff data.

Result

Output fields
appliedOperationsintegerrequired
baseFingerprintstringrequired
targetFingerprintstringrequired
coverageobjectrequired
Fields
bodytruerequired
commentsbooleanrequired
stylesbooleanrequired
numberingbooleanrequired
headerFootersbooleanrequired
summaryobjectrequired
Fields
hasChangesbooleanrequired
changedComponents"body" | "comments" | "styles" | "numbering" | "headerFooters" | "parts"[]required
bodyobjectrequired
Fields
hasChangesbooleanrequired
commentsobjectrequired
Fields
hasChangesbooleanrequired
stylesobjectrequired
Fields
hasChangesbooleanrequired
numberingobjectrequired
Fields
hasChangesbooleanrequired
headerFootersobjectrequired
Fields
hasChangesbooleanrequired
partsobjectrequired
Fields
hasChangesbooleanrequired
diagnosticsstring[]required

Failures

Pre-apply throws

  • INVALID_INPUT
  • CAPABILITY_UNSUPPORTED
  • PRECONDITION_FAILED
1 more codes
  • CAPABILITY_UNAVAILABLE

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas