Document apiReferenceDiff

diff.compare

Compare the current document (base) against a previously captured target snapshot. Returns a versioned diff payload whose summary reports which components changed: body, comments, styles, numbering, header/footers, and parts.

read-onlyidempotent
doc.diff.compare(…)

Expected result

Returns a DiffPayload with a summary and opaque payload.

Inputs

targetSnapshotobjectrequired
Fields
version"sd-diff-snapshot/v1" | "sd-diff-snapshot/v2"required
engine"superdoc-v2"required
fingerprintstringrequired
coverageobjectrequired
Fields
bodytruerequired
commentsbooleanrequired
stylesbooleanrequired
numberingbooleanrequired
headerFootersbooleanrequired
payloadobjectrequired

Opaque engine-owned snapshot data.

Result

Output 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
Fields
hasChangesbooleanrequired
commentsobjectrequired
Fields
hasChangesbooleanrequired
stylesobjectrequired
Fields
hasChangesbooleanrequired
numberingobjectrequired
Fields
hasChangesbooleanrequired
headerFootersobjectrequired
Fields
hasChangesbooleanrequired
partsobjectrequired
Fields
hasChangesbooleanrequired
payloadobjectrequired

Opaque engine-owned diff data.

Failures

Pre-apply throws

  • INVALID_INPUT
  • CAPABILITY_UNSUPPORTED

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