Summary
Apply a previously computed diff payload to the current document. The document fingerprint must match the diff base fingerprint. Tracked mode governs body content only; styles, numbering, and comments are always applied directly.- Operation ID:
diff.apply - API member path:
editor.doc.diff.apply(...) - Mutates document:
yes - Idempotency:
conditional - Supports tracked mode:
yes - Supports dry run:
no - Deterministic target resolution:
yes
Expected result
Returns a DiffApplyResult with applied operation count and diagnostics.Input fields
| Field | Type | Required | Description |
|---|---|---|---|
diff | object | yes | |
diff.baseFingerprint | string | yes | |
diff.coverage | object | yes | |
diff.coverage.body | true | yes | Constant: true |
diff.coverage.comments | boolean | yes | |
diff.coverage.headerFooters | boolean | yes | |
diff.coverage.numbering | boolean | yes | |
diff.coverage.styles | boolean | yes | |
diff.engine | enum | yes | "super-editor" |
diff.payload | object | yes | |
diff.summary | object | yes | |
diff.summary.body | object | yes | |
diff.summary.body.hasChanges | boolean | yes | |
diff.summary.changedComponents | enum[] | yes | |
diff.summary.comments | object | yes | |
diff.summary.comments.hasChanges | boolean | yes | |
diff.summary.hasChanges | boolean | yes | |
diff.summary.headerFooters | object | yes | |
diff.summary.headerFooters.hasChanges | boolean | yes | |
diff.summary.numbering | object | yes | |
diff.summary.numbering.hasChanges | boolean | yes | |
diff.summary.parts | object | yes | |
diff.summary.parts.hasChanges | boolean | yes | |
diff.summary.styles | object | yes | |
diff.summary.styles.hasChanges | boolean | yes | |
diff.targetFingerprint | string | yes | |
diff.version | enum | yes | "sd-diff-payload/v1", "sd-diff-payload/v2" |
Example request
{
"diff": {
"baseFingerprint": "example",
"coverage": {
"body": true,
"comments": true,
"headerFooters": true,
"numbering": true,
"styles": true
},
"engine": "super-editor",
"payload": {},
"summary": {
"body": {
"hasChanges": true
},
"changedComponents": [
"body"
],
"comments": {
"hasChanges": true
},
"hasChanges": true,
"headerFooters": {
"hasChanges": true
},
"numbering": {
"hasChanges": true
},
"parts": {
"hasChanges": true
},
"styles": {
"hasChanges": true
}
},
"targetFingerprint": "example",
"version": "sd-diff-payload/v1"
}
}
Output fields
| Field | Type | Required | Description |
|---|---|---|---|
appliedOperations | integer | yes | |
baseFingerprint | string | yes | |
coverage | object | yes | |
coverage.body | true | yes | Constant: true |
coverage.comments | boolean | yes | |
coverage.headerFooters | boolean | yes | |
coverage.numbering | boolean | yes | |
coverage.styles | boolean | yes | |
diagnostics | string[] | yes | |
summary | object | yes | |
summary.body | object | yes | |
summary.body.hasChanges | boolean | yes | |
summary.changedComponents | enum[] | yes | |
summary.comments | object | yes | |
summary.comments.hasChanges | boolean | yes | |
summary.hasChanges | boolean | yes | |
summary.headerFooters | object | yes | |
summary.headerFooters.hasChanges | boolean | yes | |
summary.numbering | object | yes | |
summary.numbering.hasChanges | boolean | yes | |
summary.parts | object | yes | |
summary.parts.hasChanges | boolean | yes | |
summary.styles | object | yes | |
summary.styles.hasChanges | boolean | yes | |
targetFingerprint | string | yes |
Example response
{
"appliedOperations": 1,
"baseFingerprint": "example",
"coverage": {
"body": true,
"comments": true,
"headerFooters": true,
"numbering": true,
"styles": true
},
"diagnostics": [
"example"
],
"summary": {
"body": {
"hasChanges": true
},
"changedComponents": [
"body"
],
"comments": {
"hasChanges": true
},
"hasChanges": true,
"headerFooters": {
"hasChanges": true
},
"numbering": {
"hasChanges": true
},
"parts": {
"hasChanges": true
},
"styles": {
"hasChanges": true
}
},
"targetFingerprint": "example"
}
Pre-apply throws
INVALID_INPUTCAPABILITY_UNSUPPORTEDPRECONDITION_FAILEDCAPABILITY_UNAVAILABLE
Non-applied failure codes
- None
Raw schemas
Raw input schema
Raw input schema
{
"additionalProperties": false,
"properties": {
"diff": {
"additionalProperties": false,
"properties": {
"baseFingerprint": {
"type": "string"
},
"coverage": {
"additionalProperties": false,
"properties": {
"body": {
"const": true,
"type": "boolean"
},
"comments": {
"type": "boolean"
},
"headerFooters": {
"type": "boolean"
},
"numbering": {
"type": "boolean"
},
"styles": {
"type": "boolean"
}
},
"required": [
"body",
"comments",
"styles",
"numbering",
"headerFooters"
],
"type": "object"
},
"engine": {
"enum": [
"super-editor"
],
"type": "string"
},
"payload": {
"description": "Opaque engine-owned diff data.",
"type": "object"
},
"summary": {
"additionalProperties": false,
"properties": {
"body": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"changedComponents": {
"items": {
"enum": [
"body",
"comments",
"styles",
"numbering",
"headerFooters",
"parts"
],
"type": "string"
},
"type": "array"
},
"comments": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"hasChanges": {
"type": "boolean"
},
"headerFooters": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"numbering": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"parts": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"styles": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
}
},
"required": [
"hasChanges",
"changedComponents",
"body",
"comments",
"styles",
"numbering",
"headerFooters",
"parts"
],
"type": "object"
},
"targetFingerprint": {
"type": "string"
},
"version": {
"enum": [
"sd-diff-payload/v1",
"sd-diff-payload/v2"
],
"type": "string"
}
},
"required": [
"version",
"engine",
"baseFingerprint",
"targetFingerprint",
"coverage",
"summary",
"payload"
],
"type": "object"
}
},
"required": [
"diff"
],
"type": "object"
}
Raw output schema
Raw output schema
{
"additionalProperties": false,
"properties": {
"appliedOperations": {
"type": "integer"
},
"baseFingerprint": {
"type": "string"
},
"coverage": {
"additionalProperties": false,
"properties": {
"body": {
"const": true,
"type": "boolean"
},
"comments": {
"type": "boolean"
},
"headerFooters": {
"type": "boolean"
},
"numbering": {
"type": "boolean"
},
"styles": {
"type": "boolean"
}
},
"required": [
"body",
"comments",
"styles",
"numbering",
"headerFooters"
],
"type": "object"
},
"diagnostics": {
"items": {
"type": "string"
},
"type": "array"
},
"summary": {
"additionalProperties": false,
"properties": {
"body": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"changedComponents": {
"items": {
"enum": [
"body",
"comments",
"styles",
"numbering",
"headerFooters",
"parts"
],
"type": "string"
},
"type": "array"
},
"comments": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"hasChanges": {
"type": "boolean"
},
"headerFooters": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"numbering": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"parts": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"styles": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
}
},
"required": [
"hasChanges",
"changedComponents",
"body",
"comments",
"styles",
"numbering",
"headerFooters",
"parts"
],
"type": "object"
},
"targetFingerprint": {
"type": "string"
}
},
"required": [
"appliedOperations",
"baseFingerprint",
"targetFingerprint",
"coverage",
"summary",
"diagnostics"
],
"type": "object"
}
Raw success schema
Raw success schema
{
"additionalProperties": false,
"properties": {
"appliedOperations": {
"type": "integer"
},
"baseFingerprint": {
"type": "string"
},
"coverage": {
"additionalProperties": false,
"properties": {
"body": {
"const": true,
"type": "boolean"
},
"comments": {
"type": "boolean"
},
"headerFooters": {
"type": "boolean"
},
"numbering": {
"type": "boolean"
},
"styles": {
"type": "boolean"
}
},
"required": [
"body",
"comments",
"styles",
"numbering",
"headerFooters"
],
"type": "object"
},
"diagnostics": {
"items": {
"type": "string"
},
"type": "array"
},
"summary": {
"additionalProperties": false,
"properties": {
"body": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"changedComponents": {
"items": {
"enum": [
"body",
"comments",
"styles",
"numbering",
"headerFooters",
"parts"
],
"type": "string"
},
"type": "array"
},
"comments": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"hasChanges": {
"type": "boolean"
},
"headerFooters": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"numbering": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"parts": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
},
"styles": {
"additionalProperties": false,
"properties": {
"hasChanges": {
"type": "boolean"
}
},
"required": [
"hasChanges"
],
"type": "object"
}
},
"required": [
"hasChanges",
"changedComponents",
"body",
"comments",
"styles",
"numbering",
"headerFooters",
"parts"
],
"type": "object"
},
"targetFingerprint": {
"type": "string"
}
},
"required": [
"appliedOperations",
"baseFingerprint",
"targetFingerprint",
"coverage",
"summary",
"diagnostics"
],
"type": "object"
}
Raw failure schema
Raw failure schema
{
"type": "object"
}