# Core operations Primary read and write operations. ## get - Member path: `doc.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an SDDocument with body content projected into SDM/1 canonical shapes. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "options": { "type": "object", "properties": { "includeResolved": { "type": "boolean" }, "includeProvenance": { "type": "boolean" }, "includeContext": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "modelVersion": { "const": "sdm/1" }, "body": { "type": "array" } }, "additionalProperties": false, "required": [ "modelVersion", "body" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - None ## find - Member path: `doc.find(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an SDFindResult envelope ({ total, limit, offset, items }). Each item is an SDNodeResult ({ node, address }). ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "select": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "text" }, "pattern": { "type": "string" }, "mode": { "enum": [ "contains", "regex" ] }, "caseSensitive": { "type": "boolean" }, "wholeWord": { "type": "boolean" }, "includeDeletedText": { "type": "boolean" } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node" }, "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "options": { "type": "object", "properties": { "includeResolved": { "type": "boolean" }, "includeProvenance": { "type": "boolean" }, "includeContext": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "select" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "NodeAddress": { "oneOf": [ { "$ref": "#/$defs/BlockNodeAddress" }, { "$ref": "#/$defs/InlineNodeAddress" } ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "InlineNodeAddress": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "enum": [ "run", "bookmark", "comment", "hyperlink", "sdt", "image", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ] }, "anchor": { "$ref": "#/$defs/InlineAnchor" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "total": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "node": { "type": "object" }, "address": { "$ref": "#/$defs/NodeAddress" }, "context": { "type": "object" } }, "additionalProperties": false, "required": [ "node", "address" ] } } }, "additionalProperties": false, "required": [ "total", "limit", "offset", "items" ] } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` - `ADDRESS_STALE` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - None ## getNode - Member path: `doc.getNode(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an SDNodeResult envelope with the projected SDM/1 node and canonical address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "NodeAddress": { "oneOf": [ { "$ref": "#/$defs/BlockNodeAddress" }, { "$ref": "#/$defs/InlineNodeAddress" } ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "InlineNodeAddress": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "enum": [ "run", "bookmark", "comment", "hyperlink", "sdt", "image", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ] }, "anchor": { "$ref": "#/$defs/InlineAnchor" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "$ref": "#/$defs/NodeAddress" } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "NodeAddress": { "oneOf": [ { "$ref": "#/$defs/BlockNodeAddress" }, { "$ref": "#/$defs/InlineNodeAddress" } ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "InlineNodeAddress": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "enum": [ "run", "bookmark", "comment", "hyperlink", "sdt", "image", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ] }, "anchor": { "$ref": "#/$defs/InlineAnchor" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "node": { "type": "object" }, "address": { "$ref": "#/$defs/NodeAddress" }, "context": { "type": "object" } }, "additionalProperties": false, "required": [ "node", "address" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `ADDRESS_STALE` ### Non-applied receipt codes - None ## getNodeById - Member path: `doc.getNodeById(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an SDNodeResult envelope with the projected SDM/1 node and canonical address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "nodeId": { "type": "string" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] } }, "additionalProperties": false, "required": [ "nodeId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "NodeAddress": { "oneOf": [ { "$ref": "#/$defs/BlockNodeAddress" }, { "$ref": "#/$defs/InlineNodeAddress" } ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "InlineNodeAddress": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "enum": [ "run", "bookmark", "comment", "hyperlink", "sdt", "image", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ] }, "anchor": { "$ref": "#/$defs/InlineAnchor" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "node": { "type": "object" }, "address": { "$ref": "#/$defs/NodeAddress" }, "context": { "type": "object" } }, "additionalProperties": false, "required": [ "node", "address" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` ### Non-applied receipt codes - None ## getText - Member path: `doc.getText(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns the full plain-text content of the document as a string. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "string" } ``` ### Pre-apply throws - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - None ## getMarkdown - Member path: `doc.getMarkdown(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns the full document content as a Markdown-formatted string. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "string" } ``` ### Pre-apply throws - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - None ## getHtml - Member path: `doc.getHtml(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns the full document content as an HTML-formatted string. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "unflattenLists": { "type": "boolean", "description": "When true, flattens nested list structures in output. Default: false." } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "string" } ``` ### Pre-apply throws - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - None ## markdownToFragment - Member path: `doc.markdownToFragment(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an SDMarkdownToFragmentResult with the converted fragment, lossy flag, and diagnostics. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "markdown": { "type": "string" } }, "additionalProperties": false, "required": [ "markdown" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "fragment": {}, "lossy": { "type": "boolean" }, "diagnostics": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string", "enum": [ "error", "warning", "info" ] }, "message": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "code", "severity", "message" ] } } }, "additionalProperties": false, "required": [ "fragment", "lossy", "diagnostics" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - None ## info - Member path: `doc.info(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a DocumentInfo object with counts (words, characters, paragraphs, headings, tables, images, comments, trackedChanges, sdtFields, lists, and optionally pages when pagination is active), document outline, capability flags, and revision. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "counts": { "type": "object", "properties": { "words": { "type": "integer" }, "characters": { "type": "integer" }, "paragraphs": { "type": "integer" }, "headings": { "type": "integer" }, "tables": { "type": "integer" }, "images": { "type": "integer" }, "comments": { "type": "integer" }, "trackedChanges": { "type": "integer" }, "sdtFields": { "type": "integer" }, "lists": { "type": "integer" }, "pages": { "type": "integer" } }, "additionalProperties": false, "required": [ "words", "characters", "paragraphs", "headings", "tables", "images", "comments", "trackedChanges", "sdtFields", "lists" ] }, "outline": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "integer" }, "text": { "type": "string" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "level", "text", "nodeId" ] } }, "capabilities": { "type": "object", "properties": { "canFind": { "type": "boolean" }, "canGetNode": { "type": "boolean" }, "canComment": { "type": "boolean" }, "canReplace": { "type": "boolean" } }, "additionalProperties": false, "required": [ "canFind", "canGetNode", "canComment", "canReplace" ] }, "revision": { "type": "string" }, "styles": { "type": "object", "properties": { "paragraphStyles": { "type": "array", "items": { "type": "object", "properties": { "styleId": { "type": "string", "description": "Style identifier (e.g. 'Normal', 'Heading1', 'BodyText')." }, "count": { "type": "integer", "description": "Number of paragraphs using this style." }, "fontFamily": { "type": "string", "description": "Font family used by text in this style." }, "fontSize": { "type": "number", "description": "Font size in half-points used by text in this style." } }, "additionalProperties": false, "required": [ "styleId", "count" ] }, "description": "Paragraph styles in use, sorted by frequency (most common first)." } }, "additionalProperties": false, "required": [ "paragraphStyles" ], "description": "Styles currently in use in the document." }, "defaults": { "type": "object", "properties": { "fontFamily": { "type": "string", "description": "Most common body text font family." }, "fontSize": { "type": "number", "description": "Most common body text font size in half-points." }, "styleId": { "type": "string", "description": "Most common body paragraph style ID." } }, "additionalProperties": false, "description": "Document's default body text formatting. Use these values when creating new content to match existing style." } }, "additionalProperties": false, "required": [ "counts", "outline", "capabilities", "revision" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - None ## extract - Member path: `doc.extract(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an ExtractResult with blocks (nodeId, type, text, headingLevel), comments (entityId, text, anchoredText, blockId, status, author), tracked changes (entityId, type, excerpt, author, date), and revision. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "blocks": { "type": "array", "items": { "type": "object", "properties": { "nodeId": { "type": "string", "description": "Stable block ID: pass to scrollToElement() for navigation." }, "type": { "type": "string", "description": "Block type: paragraph, heading, listItem, image, tableOfContents." }, "text": { "type": "string", "description": "Full plain text content of the block." }, "textSpans": { "type": "array", "description": "Block text broken into runs with tracked-change marks preserved per run. Present only when the block contains at least one tracked change. Concatenating span text yields `text`.", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Raw text of the run." }, "trackedChanges": { "type": "array", "description": "Tracked-change marks applied to this run.", "items": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Tracked change entity ID matching an entry in trackedChanges[]." }, "type": { "type": "string", "enum": [ "insert", "delete", "format" ] } }, "additionalProperties": false, "required": [ "entityId", "type" ] } } }, "additionalProperties": false, "required": [ "text" ] } }, "headingLevel": { "type": "integer", "description": "Heading level (1-6). Only present for headings." }, "tableContext": { "type": "object", "properties": { "tableOrdinal": { "type": "integer", "description": "0-based table ordinal, unique within one extract() result." }, "parentTableOrdinal": { "type": "integer", "description": "Ordinal of the parent table when the containing table is nested." }, "parentRowIndex": { "type": "integer", "description": "Row index in the parent table. Set with parentTableOrdinal." }, "parentColumnIndex": { "type": "integer", "description": "Column index in the parent table. Set with parentTableOrdinal." }, "rowIndex": { "type": "integer", "description": "0-based row index of the containing cell." }, "columnIndex": { "type": "integer", "description": "0-based logical grid column, not the row child order." }, "rowspan": { "type": "integer", "description": "Number of rows the cell spans." }, "colspan": { "type": "integer", "description": "Number of columns the cell spans." } }, "additionalProperties": false, "required": [ "tableOrdinal", "rowIndex", "columnIndex", "rowspan", "colspan" ] } }, "additionalProperties": false, "required": [ "nodeId", "type", "text" ] } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Comment entity ID: pass to scrollToElement() for navigation." }, "text": { "type": "string", "description": "Comment body text." }, "anchoredText": { "type": "string", "description": "The document text the comment is anchored to." }, "blockId": { "type": "string", "description": "Block ID the comment is anchored to." }, "status": { "type": "string", "enum": [ "open", "resolved" ] }, "author": { "type": "string", "description": "Comment author name." } }, "additionalProperties": false, "required": [ "entityId", "status" ] } }, "trackedChanges": { "type": "array", "items": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Tracked change entity ID. Pass to scrollToElement() for navigation." }, "type": { "type": "string", "enum": [ "insert", "delete", "replacement", "format" ], "description": "Aggregate type at the entity level. In paired replacement mode, a delete+insert pair shares one entity and this surfaces as 'replacement'; per-half type lives on block.textSpans[].trackedChanges[]." }, "blockIds": { "type": "array", "description": "Block IDs whose textSpans carry this change.", "items": { "type": "string" } }, "wordRevisionIds": { "type": "object", "properties": { "insert": { "type": "string", "description": "Original OOXML w:id from a w:ins mark." }, "delete": { "type": "string", "description": "Original OOXML w:id from a w:del mark." }, "format": { "type": "string", "description": "Original OOXML w:id from a w:rPrChange mark." } }, "additionalProperties": false }, "excerpt": { "type": "string", "description": "Short text excerpt of the changed content. Omitted for paired replacements; read block.textSpans for the per-half text." }, "author": { "type": "string", "description": "Change author name." }, "date": { "type": "string", "description": "Change date (ISO string)." } }, "additionalProperties": false, "required": [ "entityId", "type" ] } }, "revision": { "type": "string", "description": "Document revision at the time of extraction." } }, "additionalProperties": false, "required": [ "blocks", "comments", "trackedChanges", "revision" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - None ## clearContent - Member path: `doc.clearContent(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a Receipt with success status; reports NO_OP if the document is already empty. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptSuccess": { "type": "object", "properties": { "success": { "const": true }, "id": { "type": "string" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "invalidatedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRef" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" } }, "additionalProperties": false, "required": [ "success" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "$ref": "#/$defs/ReceiptSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## insert - Member path: `doc.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an SDMutationReceipt with applied status; resolution reports the resolved insertion point/target. Created visible text and structural blocks are reported through effects.insertedText and effects.insertedBlocks when available. Receipt reports NO_OP if the insertion point is invalid or content is empty. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}." }, "in": { "$ref": "#/$defs/StoryLocator" }, "value": { "type": "string", "description": "Text content to insert." }, "type": { "type": "string", "enum": [ "text", "markdown", "html" ], "description": "Content format: 'text' (default), 'markdown', or 'html'." } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref from superdoc_search result (pass handle.ref value directly). Preferred over building a target object." }, "in": { "$ref": "#/$defs/StoryLocator" }, "value": { "type": "string", "description": "Text content to insert." }, "type": { "type": "string", "enum": [ "text", "markdown", "html" ], "description": "Content format: 'text' (default), 'markdown', or 'html'." } }, "additionalProperties": false, "required": [ "ref", "value" ] }, { "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "value": { "type": "string", "description": "Text content to insert." }, "type": { "type": "string", "enum": [ "text", "markdown", "html" ], "description": "Content format: 'text' (default), 'markdown', or 'html'." } }, "additionalProperties": false, "required": [ "value" ] } ] }, { "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "target": { "$ref": "#/$defs/BlockNodeAddress", "description": "Block address for structural insertion: {kind:'block', nodeType:'...', nodeId:'...'}." }, "content": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ], "description": "Document fragment to insert (structured content)." }, "placement": { "enum": [ "before", "after", "insideStart", "insideEnd" ], "description": "Where to place content relative to target: 'before', 'after', 'insideStart', or 'insideEnd'." }, "nestingPolicy": { "type": "object", "properties": { "tables": { "enum": [ "forbid", "allow" ] } }, "additionalProperties": false, "description": "Controls nesting behavior. tables: 'allow' permits inserting tables inside other tables." } }, "additionalProperties": false, "required": [ "content" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BlockNodeAddress" } ] }, "range": { "$ref": "#/$defs/TextMutationRange" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range" ] }, "effects": { "$ref": "#/$defs/ReceiptEffects" }, "evaluatedRevision": { "type": "object", "properties": { "before": { "type": "string" }, "after": { "type": "string" } }, "additionalProperties": false, "required": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "NO_OP", "CAPABILITY_UNAVAILABLE", "UNSUPPORTED_ENVIRONMENT", "INVALID_NESTING", "INVALID_PLACEMENT", "INVALID_PAYLOAD", "CAPABILITY_UNSUPPORTED", "ADDRESS_STALE", "DUPLICATE_ID", "INVALID_CONTEXT", "RAW_MODE_REQUIRED", "PRESERVE_ONLY_VIOLATION", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BlockNodeAddress" } ] }, "range": { "$ref": "#/$defs/TextMutationRange" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range" ] }, "evaluatedRevision": { "type": "object", "properties": { "before": { "type": "string" }, "after": { "type": "string" } }, "additionalProperties": false, "required": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `ADDRESS_STALE` - `DUPLICATE_ID` - `RAW_MODE_REQUIRED` - `PRESERVE_ONLY_VIOLATION` - `CAPABILITY_UNSUPPORTED` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` - `CAPABILITY_UNAVAILABLE` - `UNSUPPORTED_ENVIRONMENT` - `INVALID_NESTING` - `INVALID_PLACEMENT` - `INVALID_PAYLOAD` - `CAPABILITY_UNSUPPORTED` - `ADDRESS_STALE` - `DUPLICATE_ID` - `INVALID_CONTEXT` - `RAW_MODE_REQUIRED` - `PRESERVE_ONLY_VIOLATION` - `INVALID_INPUT` ## replace - Member path: `doc.replace(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an SDMutationReceipt with applied status; receipt reports NO_OP if the target range already contains identical content. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "in": { "$ref": "#/$defs/StoryLocator" }, "text": { "type": "string", "description": "Replacement text content." } }, "additionalProperties": false, "required": [ "target", "text" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "in": { "$ref": "#/$defs/StoryLocator" }, "text": { "type": "string", "description": "Replacement text content." } }, "additionalProperties": false, "required": [ "ref", "text" ] } ] }, { "oneOf": [ { "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "target": { "oneOf": [ { "$ref": "#/$defs/BlockNodeAddress" }, { "$ref": "#/$defs/SelectionTarget" } ], "description": "Target block or selection to replace." }, "content": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ], "description": "Document fragment to replace with (structured content)." }, "nestingPolicy": { "type": "object", "properties": { "tables": { "enum": [ "forbid", "allow" ] } }, "additionalProperties": false, "description": "Controls nesting behavior. tables: 'allow' permits inserting tables inside other tables." } }, "additionalProperties": false, "required": [ "target", "content" ] }, { "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "ref": { "type": "string", "description": "Reference handle from a previous search result." }, "content": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ], "description": "Document fragment to replace with (structured content)." }, "nestingPolicy": { "type": "object", "properties": { "tables": { "enum": [ "forbid", "allow" ] } }, "additionalProperties": false, "description": "Controls nesting behavior. tables: 'allow' permits inserting tables inside other tables." } }, "additionalProperties": false, "required": [ "ref", "content" ] } ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BlockNodeAddress" } ] }, "range": { "$ref": "#/$defs/TextMutationRange" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range" ] }, "effects": { "$ref": "#/$defs/ReceiptEffects" }, "evaluatedRevision": { "type": "object", "properties": { "before": { "type": "string" }, "after": { "type": "string" } }, "additionalProperties": false, "required": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "NO_OP", "INVALID_NESTING", "INVALID_PLACEMENT", "INVALID_PAYLOAD", "CAPABILITY_UNSUPPORTED", "ADDRESS_STALE", "DUPLICATE_ID", "INVALID_CONTEXT", "RAW_MODE_REQUIRED", "PRESERVE_ONLY_VIOLATION", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BlockNodeAddress" } ] }, "range": { "$ref": "#/$defs/TextMutationRange" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range" ] }, "evaluatedRevision": { "type": "object", "properties": { "before": { "type": "string" }, "after": { "type": "string" } }, "additionalProperties": false, "required": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `ADDRESS_STALE` - `DUPLICATE_ID` - `RAW_MODE_REQUIRED` - `PRESERVE_ONLY_VIOLATION` - `CAPABILITY_UNSUPPORTED` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` - `INVALID_NESTING` - `INVALID_PLACEMENT` - `INVALID_PAYLOAD` - `CAPABILITY_UNSUPPORTED` - `ADDRESS_STALE` - `DUPLICATE_ID` - `INVALID_CONTEXT` - `RAW_MODE_REQUIRED` - `PRESERVE_ONLY_VIOLATION` - `INVALID_INPUT` ## delete - Member path: `doc.delete(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt with applied status; receipt reports NO_OP if the target range is collapsed or empty. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "DeleteBehavior": { "enum": [ "selection", "exact" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "in": { "$ref": "#/$defs/StoryLocator" }, "behavior": { "$ref": "#/$defs/DeleteBehavior", "description": "Delete behavior: 'selection' (default) or 'exact'." } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "in": { "$ref": "#/$defs/StoryLocator" }, "behavior": { "$ref": "#/$defs/DeleteBehavior", "description": "Delete behavior: 'selection' (default) or 'exact'." } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `NO_OP` # Blocks operations Block-level structural operations. ## blocks.list - Member path: `doc.blocks.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a BlocksListResult with total block count, an ordered array of block entries (ordinal, nodeId, nodeType, textPreview, optional text, isEmpty), and the current document revision. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "offset": { "type": "number", "minimum": 0, "description": "Number of blocks to skip. Default: 0." }, "limit": { "type": "number", "minimum": 1, "description": "Maximum blocks to return. Omit for all blocks." }, "nodeTypes": { "type": "array", "items": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "description": "Filter by block types (e.g. ['paragraph', 'heading']). Omit for all types." }, "includeText": { "type": "boolean", "description": "When true, includes the full flattened block text in each block entry." } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "total": { "type": "number" }, "blocks": { "type": "array", "items": { "type": "object", "properties": { "ordinal": { "type": "number" }, "nodeId": { "type": "string", "description": "Block ID for targeting with other tools." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "textPreview": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full flattened block text when requested with includeText." }, "isEmpty": { "type": "boolean" }, "styleId": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Named paragraph style." }, "fontFamily": { "type": "string", "description": "Font family from first text run." }, "fontSize": { "type": "number", "description": "Font size from first text run." }, "bold": { "type": "boolean", "description": "True if text is bold." }, "color": { "type": "string", "description": "Text color when explicitly set (e.g. '#000000')." }, "alignment": { "type": "string", "description": "Paragraph alignment." }, "headingLevel": { "type": "number", "description": "Heading level (1-6)." }, "paragraphNumbering": { "type": "object", "description": "Numbering reference (numId + level) for numbered blocks, including numbered headings. Absent for non-numbered blocks.", "properties": { "numId": { "type": "number" }, "level": { "type": "number" } }, "additionalProperties": false }, "numbering": { "type": "object", "properties": { "marker": { "type": "string" }, "path": { "type": "array", "items": { "type": "number" } }, "kind": { "enum": [ "ordered", "bullet" ] } }, "additionalProperties": false, "required": [ "marker", "path", "kind" ] }, "ref": { "type": "string", "description": "Ref handle for this block. Pass directly to superdoc_format or superdoc_edit ref param. Only present for non-empty blocks." } }, "additionalProperties": false, "required": [ "ordinal", "nodeId", "nodeType" ] } }, "revision": { "type": "string" } }, "additionalProperties": false, "required": [ "total", "blocks", "revision" ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - None ## blocks.delete - Member path: `doc.blocks.delete(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a BlocksDeleteResult receipt confirming the block was removed, including a deletedBlock summary with ordinal, nodeType, and textPreview. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "DeletableBlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/DeletableBlockNodeAddress" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "DeletableBlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "type": "object", "properties": { "success": { "const": true }, "deleted": { "$ref": "#/$defs/DeletableBlockNodeAddress" }, "deletedBlock": { "type": "object", "properties": { "ordinal": { "type": "number" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" }, "textPreview": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "invalidatedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRef" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" } }, "additionalProperties": false, "required": [ "success", "deleted" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `INTERNAL_ERROR` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - None ## blocks.deleteRange - Member path: `doc.blocks.deleteRange(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a BlocksDeleteRangeResult with deletedCount, deletedBlocks array (each with ordinal, nodeId, nodeType, textPreview), before/after revision, and dryRun flag. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "start": { "$ref": "#/$defs/BlockNodeAddress" }, "end": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "start", "end" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "type": "object", "properties": { "success": { "const": true }, "deletedCount": { "type": "number" }, "deletedBlocks": { "type": "array", "items": { "type": "object", "properties": { "ordinal": { "type": "number" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" }, "textPreview": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ordinal", "nodeId", "nodeType", "textPreview" ] } }, "revision": { "type": "object", "properties": { "before": { "type": "string" }, "after": { "type": "string" } }, "additionalProperties": false, "required": [ "before", "after" ] }, "dryRun": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } }, "invalidatedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRef" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" } }, "additionalProperties": false, "required": [ "success", "deletedCount", "deletedBlocks", "revision", "dryRun" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - None ## blocks.split - Member path: `doc.blocks.split(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: no ### Expected result Returns a BlocksSplitResult; on success carries the new tail paragraph address, affectedStories, and (for engines that report them) story-absolute textRangeShifts and a txId for history correlation. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/BlockNodeAddress" }, "offset": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "target", "offset" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "type": "object", "properties": { "success": { "const": true }, "inserted": { "$ref": "#/$defs/BlockNodeAddress" }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" } }, "additionalProperties": false, "required": [ "success", "inserted" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `INVALID_TARGET` - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_CONTEXT` - `INVALID_INPUT` ## blocks.merge - Member path: `doc.blocks.merge(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: no ### Expected result Returns a BlocksMergeResult; on success carries the removed paragraph address plus affectedStories, textRangeShifts, and a txId. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "first": { "$ref": "#/$defs/BlockNodeAddress" }, "second": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "first", "second" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "type": "object", "properties": { "success": { "const": true }, "removed": { "$ref": "#/$defs/BlockNodeAddress" }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" } }, "additionalProperties": false, "required": [ "success", "removed" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `INVALID_TARGET` - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_CONTEXT` - `INVALID_INPUT` ## blocks.move - Member path: `doc.blocks.move(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: no ### Expected result Returns a BlocksMoveResult; on success carries the moved paragraph address plus affectedStories and a txId. Tracked-mode results include `trackedChangeRefs` pointing at the paired move review entity. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "source": { "$ref": "#/$defs/BlockNodeAddress" }, "destination": { "$ref": "#/$defs/BlockNodeAddress" }, "placement": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "source", "destination", "placement" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] } }, "type": "object", "properties": { "success": { "const": true }, "moved": { "$ref": "#/$defs/BlockNodeAddress" }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "txId": { "type": "string" } }, "additionalProperties": false, "required": [ "success", "moved" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `INVALID_TARGET` - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_CONTEXT` - `INVALID_INPUT` # Capabilities operations Runtime support discovery for capability-aware branching. ## capabilities.get - Member path: `doc.capabilities()` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a DocumentApiCapabilities object describing supported features of the current engine. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "global": { "type": "object", "properties": { "trackChanges": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "enabled" ] }, "comments": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "enabled" ] }, "lists": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "enabled" ] }, "dryRun": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "enabled" ] }, "history": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "enabled" ] } }, "additionalProperties": false, "required": [ "trackChanges", "comments", "lists", "dryRun", "history" ] }, "format": { "type": "object", "properties": { "supportedInlineProperties": { "type": "object", "properties": { "bold": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "italic": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "strike": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "underline": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "highlight": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "color": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "fontSize": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "fontFamily": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "letterSpacing": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "vertAlign": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "position": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "dstrike": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "smallCaps": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "caps": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "shading": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "border": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "outline": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "shadow": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "emboss": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "imprint": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "charScale": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "kerning": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "vanish": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "webHidden": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "specVanish": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "rtl": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "cs": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "bCs": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "iCs": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "eastAsianLayout": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "em": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "fitText": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "snapToGrid": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "lang": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "oMath": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "rStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "rFonts": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "fontSizeCs": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "ligatures": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "numForm": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "numSpacing": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "stylisticSets": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] }, "contextualAlternates": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "type": { "enum": [ "boolean", "string", "number", "object", "array" ] }, "storage": { "enum": [ "mark", "runAttribute" ] } }, "additionalProperties": false, "required": [ "available", "tracked", "type", "storage" ] } }, "additionalProperties": false, "required": [ "bold", "italic", "strike", "underline", "highlight", "color", "fontSize", "fontFamily", "letterSpacing", "vertAlign", "position", "dstrike", "smallCaps", "caps", "shading", "border", "outline", "shadow", "emboss", "imprint", "charScale", "kerning", "vanish", "webHidden", "specVanish", "rtl", "cs", "bCs", "iCs", "eastAsianLayout", "em", "fitText", "snapToGrid", "lang", "oMath", "rStyle", "rFonts", "fontSizeCs", "ligatures", "numForm", "numSpacing", "stylisticSets", "contextualAlternates" ] } }, "additionalProperties": false, "required": [ "supportedInlineProperties" ] }, "operations": { "type": "object", "properties": { "get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "find": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "getNode": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "getNodeById": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "getText": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "getMarkdown": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "getHtml": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "markdownToFragment": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "info": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "extract": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "clearContent": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "replace": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "delete": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "formatRange": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "blocks.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "blocks.delete": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "blocks.deleteRange": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "blocks.split": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "blocks.merge": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "blocks.move": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.apply": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.bold": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.italic": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.strike": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.underline": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.highlight": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.color": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.fontSize": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.fontFamily": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.letterSpacing": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.vertAlign": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.position": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.dstrike": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.smallCaps": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.caps": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.shading": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.border": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.outline": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.shadow": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.emboss": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.imprint": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.charScale": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.kerning": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.vanish": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.webHidden": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.specVanish": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.rtl": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.cs": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.bCs": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.iCs": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.eastAsianLayout": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.em": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.fitText": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.snapToGrid": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.lang": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.oMath": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.rStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.rFonts": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.fontSizeCs": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.ligatures": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.numForm": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.numSpacing": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.stylisticSets": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.contextualAlternates": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "styles.apply": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "styles.getCatalog": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "templates.apply": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "create.paragraph": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "create.heading": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "create.sectionBreak": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setBreakType": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setPageMargins": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setHeaderFooterMargins": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setPageSetup": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setColumns": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setLineNumbering": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setPageNumbering": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setTitlePage": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setOddEvenHeadersFooters": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setVerticalAlign": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setSectionDirection": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setHeaderFooterRef": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.clearHeaderFooterRef": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setLinkToPrevious": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.setPageBorders": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "sections.clearPageBorders": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "styles.paragraph.setStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "styles.paragraph.setStyleRef": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "styles.paragraph.clearStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.resetDirectFormatting": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setAlignment": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.clearAlignment": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setIndentation": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.clearIndentation": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setSpacing": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.clearSpacing": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setKeepOptions": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setOutlineLevel": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setFlowOptions": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setTabStop": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.clearTabStop": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.clearAllTabStops": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setBorder": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.clearBorder": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setShading": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.clearShading": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setMarkRunProps": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setDirection": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.clearDirection": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "format.paragraph.setNumbering": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.create": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.attach": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.detach": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.delete": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.indent": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.outdent": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.join": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.canJoin": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.separate": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.merge": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.split": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevel": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setValue": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.continuePrevious": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.canContinuePrevious": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelRestart": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.convertToText": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.applyTemplate": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.applyPreset": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setType": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.captureTemplate": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelNumbering": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelBullet": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelPictureBullet": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelAlignment": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelIndents": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelTrailingCharacter": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelMarkerFont": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.clearLevelOverrides": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.getStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.applyStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.restartAt": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelNumberStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelText": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelStart": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.setLevelLayout": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.getState": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.apply": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.continue": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.restart": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "lists.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "comments.create": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "comments.patch": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "comments.delete": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "comments.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "comments.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "trackChanges.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "trackChanges.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "trackChanges.decide": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "query.match": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "ranges.resolve": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "selection.current": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "mutations.preview": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "mutations.apply": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "plan.execute": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "capabilities.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "create.table": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.convertFromText": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.delete": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.clearContents": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.move": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.split": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.convertToText": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setLayout": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.insertRow": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.deleteRow": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.moveRow": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setRowHeight": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.distributeRows": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setRowOptions": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.insertColumn": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.deleteColumn": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setColumnWidth": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.distributeColumns": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.insertCell": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.deleteCell": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.mergeCells": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.unmergeCells": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.splitCell": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setCellProperties": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setCellText": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.sort": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setAltText": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.clearStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setStyleOption": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setBorder": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.clearBorder": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.applyBorderPreset": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setShading": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.clearShading": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setTablePadding": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setCellPadding": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setCellSpacing": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.clearCellSpacing": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.applyStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setBorders": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setTableOptions": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.applyPreset": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.getCells": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.getProperties": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.getStyles": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.setDefaultStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "tables.clearDefaultStyle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "create.tableOfContents": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "toc.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "toc.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "toc.configure": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "toc.update": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "toc.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "toc.markEntry": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "toc.unmarkEntry": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "toc.listEntries": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "toc.getEntry": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "toc.editEntry": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "history.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "history.undo": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "history.redo": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "create.image": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.delete": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.move": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.convertToInline": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.convertToFloating": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setSize": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setWrapType": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setWrapSide": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setWrapDistances": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setPosition": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setAnchorOptions": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setZOrder": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.scale": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setLockAspectRatio": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.rotate": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.flip": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.crop": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.resetCrop": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.replaceSource": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setAltText": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setDecorative": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setName": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.setHyperlink": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.insertCaption": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.updateCaption": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "images.removeCaption": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "hyperlinks.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "hyperlinks.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "hyperlinks.wrap": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "hyperlinks.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "hyperlinks.patch": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "hyperlinks.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "headerFooters.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "headerFooters.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "headerFooters.resolve": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "headerFooters.refs.set": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "headerFooters.refs.clear": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "headerFooters.refs.setLinkedToPrevious": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "headerFooters.parts.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "headerFooters.parts.create": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "headerFooters.parts.delete": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "create.contentControl": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.listInRange": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.selectByTag": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.selectByTitle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.listChildren": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.getParent": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.wrap": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.unwrap": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.delete": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.copy": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.move": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.patch": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.setLockMode": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.setType": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.getContent": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.replaceContent": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.clearContent": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.appendContent": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.prependContent": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.insertBefore": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.insertAfter": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.getBinding": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.setBinding": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.clearBinding": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.getRawProperties": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.patchRawProperties": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.validateWordCompatibility": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.normalizeWordCompatibility": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.normalizeTagPayload": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.text.setMultiline": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.text.setValue": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.text.clearValue": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.date.setValue": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.date.clearValue": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.date.setDisplayFormat": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.date.setDisplayLocale": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.date.setStorageFormat": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.date.setCalendar": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.checkbox.getState": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.checkbox.setState": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.checkbox.toggle": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.checkbox.setSymbolPair": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.choiceList.getItems": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.choiceList.setItems": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.choiceList.setSelected": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.repeatingSection.listItems": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.repeatingSection.insertItemBefore": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.repeatingSection.insertItemAfter": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.repeatingSection.cloneItem": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.repeatingSection.deleteItem": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.repeatingSection.setAllowInsertDelete": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.group.wrap": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "contentControls.group.ungroup": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "bookmarks.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "bookmarks.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "bookmarks.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "bookmarks.rename": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "bookmarks.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "footnotes.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "footnotes.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "footnotes.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "footnotes.update": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "footnotes.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "footnotes.configure": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "clipboard.parse": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "clipboard.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "clipboard.serializeSelection": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "crossRefs.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "crossRefs.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "crossRefs.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "crossRefs.rebuild": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "crossRefs.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "index.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "index.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "index.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "index.configure": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "index.rebuild": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "index.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "index.entries.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "index.entries.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "index.entries.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "index.entries.update": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "index.entries.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "captions.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "captions.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "captions.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "captions.update": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "captions.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "captions.configure": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "fields.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "fields.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "fields.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "fields.rebuild": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "fields.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.update": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.sources.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.sources.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.sources.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.sources.update": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.sources.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.bibliography.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.bibliography.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.bibliography.rebuild": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.bibliography.configure": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "citations.bibliography.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "authorities.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "authorities.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "authorities.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "authorities.configure": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "authorities.rebuild": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "authorities.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "authorities.entries.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "authorities.entries.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "authorities.entries.insert": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "authorities.entries.update": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "authorities.entries.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "diff.capture": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "diff.compare": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "diff.apply": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "export.toDocx": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "protection.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "protection.setEditingRestriction": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "protection.clearEditingRestriction": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "permissionRanges.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "permissionRanges.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "permissionRanges.create": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "permissionRanges.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "permissionRanges.updatePrincipal": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "customXml.parts.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "customXml.parts.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "customXml.parts.create": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "customXml.parts.patch": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "customXml.parts.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "metadata.attach": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "metadata.list": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "metadata.get": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "metadata.update": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "metadata.remove": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] }, "metadata.resolve": { "type": "object", "properties": { "available": { "type": "boolean" }, "tracked": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "reasons": { "type": "array", "items": { "enum": [ "COMMAND_UNAVAILABLE", "HELPER_UNAVAILABLE", "OPERATION_UNAVAILABLE", "TRACKED_MODE_UNAVAILABLE", "DRY_RUN_UNAVAILABLE", "NAMESPACE_UNAVAILABLE", "STYLES_PART_MISSING", "COLLABORATION_ACTIVE" ] } } }, "additionalProperties": false, "required": [ "available", "tracked", "dryRun" ] } }, "additionalProperties": false, "required": [ "get", "find", "getNode", "getNodeById", "getText", "getMarkdown", "getHtml", "markdownToFragment", "info", "extract", "clearContent", "insert", "replace", "delete", "formatRange", "blocks.list", "blocks.delete", "blocks.deleteRange", "blocks.split", "blocks.merge", "blocks.move", "format.apply", "format.bold", "format.italic", "format.strike", "format.underline", "format.highlight", "format.color", "format.fontSize", "format.fontFamily", "format.letterSpacing", "format.vertAlign", "format.position", "format.dstrike", "format.smallCaps", "format.caps", "format.shading", "format.border", "format.outline", "format.shadow", "format.emboss", "format.imprint", "format.charScale", "format.kerning", "format.vanish", "format.webHidden", "format.specVanish", "format.rtl", "format.cs", "format.bCs", "format.iCs", "format.eastAsianLayout", "format.em", "format.fitText", "format.snapToGrid", "format.lang", "format.oMath", "format.rStyle", "format.rFonts", "format.fontSizeCs", "format.ligatures", "format.numForm", "format.numSpacing", "format.stylisticSets", "format.contextualAlternates", "styles.apply", "styles.getCatalog", "templates.apply", "create.paragraph", "create.heading", "create.sectionBreak", "sections.list", "sections.get", "sections.setBreakType", "sections.setPageMargins", "sections.setHeaderFooterMargins", "sections.setPageSetup", "sections.setColumns", "sections.setLineNumbering", "sections.setPageNumbering", "sections.setTitlePage", "sections.setOddEvenHeadersFooters", "sections.setVerticalAlign", "sections.setSectionDirection", "sections.setHeaderFooterRef", "sections.clearHeaderFooterRef", "sections.setLinkToPrevious", "sections.setPageBorders", "sections.clearPageBorders", "styles.paragraph.setStyle", "styles.paragraph.setStyleRef", "styles.paragraph.clearStyle", "format.paragraph.resetDirectFormatting", "format.paragraph.setAlignment", "format.paragraph.clearAlignment", "format.paragraph.setIndentation", "format.paragraph.clearIndentation", "format.paragraph.setSpacing", "format.paragraph.clearSpacing", "format.paragraph.setKeepOptions", "format.paragraph.setOutlineLevel", "format.paragraph.setFlowOptions", "format.paragraph.setTabStop", "format.paragraph.clearTabStop", "format.paragraph.clearAllTabStops", "format.paragraph.setBorder", "format.paragraph.clearBorder", "format.paragraph.setShading", "format.paragraph.clearShading", "format.paragraph.setMarkRunProps", "format.paragraph.setDirection", "format.paragraph.clearDirection", "format.paragraph.setNumbering", "lists.list", "lists.get", "lists.insert", "lists.create", "lists.attach", "lists.detach", "lists.delete", "lists.indent", "lists.outdent", "lists.join", "lists.canJoin", "lists.separate", "lists.merge", "lists.split", "lists.setLevel", "lists.setValue", "lists.continuePrevious", "lists.canContinuePrevious", "lists.setLevelRestart", "lists.convertToText", "lists.applyTemplate", "lists.applyPreset", "lists.setType", "lists.captureTemplate", "lists.setLevelNumbering", "lists.setLevelBullet", "lists.setLevelPictureBullet", "lists.setLevelAlignment", "lists.setLevelIndents", "lists.setLevelTrailingCharacter", "lists.setLevelMarkerFont", "lists.clearLevelOverrides", "lists.getStyle", "lists.applyStyle", "lists.restartAt", "lists.setLevelNumberStyle", "lists.setLevelText", "lists.setLevelStart", "lists.setLevelLayout", "lists.getState", "lists.apply", "lists.continue", "lists.restart", "lists.remove", "comments.create", "comments.patch", "comments.delete", "comments.get", "comments.list", "trackChanges.list", "trackChanges.get", "trackChanges.decide", "query.match", "ranges.resolve", "selection.current", "mutations.preview", "mutations.apply", "plan.execute", "capabilities.get", "create.table", "tables.convertFromText", "tables.delete", "tables.clearContents", "tables.move", "tables.split", "tables.convertToText", "tables.setLayout", "tables.insertRow", "tables.deleteRow", "tables.moveRow", "tables.setRowHeight", "tables.distributeRows", "tables.setRowOptions", "tables.insertColumn", "tables.deleteColumn", "tables.setColumnWidth", "tables.distributeColumns", "tables.insertCell", "tables.deleteCell", "tables.mergeCells", "tables.unmergeCells", "tables.splitCell", "tables.setCellProperties", "tables.setCellText", "tables.sort", "tables.setAltText", "tables.setStyle", "tables.clearStyle", "tables.setStyleOption", "tables.setBorder", "tables.clearBorder", "tables.applyBorderPreset", "tables.setShading", "tables.clearShading", "tables.setTablePadding", "tables.setCellPadding", "tables.setCellSpacing", "tables.clearCellSpacing", "tables.applyStyle", "tables.setBorders", "tables.setTableOptions", "tables.applyPreset", "tables.get", "tables.getCells", "tables.getProperties", "tables.getStyles", "tables.setDefaultStyle", "tables.clearDefaultStyle", "create.tableOfContents", "toc.list", "toc.get", "toc.configure", "toc.update", "toc.remove", "toc.markEntry", "toc.unmarkEntry", "toc.listEntries", "toc.getEntry", "toc.editEntry", "history.get", "history.undo", "history.redo", "create.image", "images.list", "images.get", "images.delete", "images.move", "images.convertToInline", "images.convertToFloating", "images.setSize", "images.setWrapType", "images.setWrapSide", "images.setWrapDistances", "images.setPosition", "images.setAnchorOptions", "images.setZOrder", "images.scale", "images.setLockAspectRatio", "images.rotate", "images.flip", "images.crop", "images.resetCrop", "images.replaceSource", "images.setAltText", "images.setDecorative", "images.setName", "images.setHyperlink", "images.insertCaption", "images.updateCaption", "images.removeCaption", "hyperlinks.list", "hyperlinks.get", "hyperlinks.wrap", "hyperlinks.insert", "hyperlinks.patch", "hyperlinks.remove", "headerFooters.list", "headerFooters.get", "headerFooters.resolve", "headerFooters.refs.set", "headerFooters.refs.clear", "headerFooters.refs.setLinkedToPrevious", "headerFooters.parts.list", "headerFooters.parts.create", "headerFooters.parts.delete", "create.contentControl", "contentControls.list", "contentControls.get", "contentControls.listInRange", "contentControls.selectByTag", "contentControls.selectByTitle", "contentControls.listChildren", "contentControls.getParent", "contentControls.wrap", "contentControls.unwrap", "contentControls.delete", "contentControls.copy", "contentControls.move", "contentControls.patch", "contentControls.setLockMode", "contentControls.setType", "contentControls.getContent", "contentControls.replaceContent", "contentControls.clearContent", "contentControls.appendContent", "contentControls.prependContent", "contentControls.insertBefore", "contentControls.insertAfter", "contentControls.getBinding", "contentControls.setBinding", "contentControls.clearBinding", "contentControls.getRawProperties", "contentControls.patchRawProperties", "contentControls.validateWordCompatibility", "contentControls.normalizeWordCompatibility", "contentControls.normalizeTagPayload", "contentControls.text.setMultiline", "contentControls.text.setValue", "contentControls.text.clearValue", "contentControls.date.setValue", "contentControls.date.clearValue", "contentControls.date.setDisplayFormat", "contentControls.date.setDisplayLocale", "contentControls.date.setStorageFormat", "contentControls.date.setCalendar", "contentControls.checkbox.getState", "contentControls.checkbox.setState", "contentControls.checkbox.toggle", "contentControls.checkbox.setSymbolPair", "contentControls.choiceList.getItems", "contentControls.choiceList.setItems", "contentControls.choiceList.setSelected", "contentControls.repeatingSection.listItems", "contentControls.repeatingSection.insertItemBefore", "contentControls.repeatingSection.insertItemAfter", "contentControls.repeatingSection.cloneItem", "contentControls.repeatingSection.deleteItem", "contentControls.repeatingSection.setAllowInsertDelete", "contentControls.group.wrap", "contentControls.group.ungroup", "bookmarks.list", "bookmarks.get", "bookmarks.insert", "bookmarks.rename", "bookmarks.remove", "footnotes.list", "footnotes.get", "footnotes.insert", "footnotes.update", "footnotes.remove", "footnotes.configure", "clipboard.parse", "clipboard.insert", "clipboard.serializeSelection", "crossRefs.list", "crossRefs.get", "crossRefs.insert", "crossRefs.rebuild", "crossRefs.remove", "index.list", "index.get", "index.insert", "index.configure", "index.rebuild", "index.remove", "index.entries.list", "index.entries.get", "index.entries.insert", "index.entries.update", "index.entries.remove", "captions.list", "captions.get", "captions.insert", "captions.update", "captions.remove", "captions.configure", "fields.list", "fields.get", "fields.insert", "fields.rebuild", "fields.remove", "citations.list", "citations.get", "citations.insert", "citations.update", "citations.remove", "citations.sources.list", "citations.sources.get", "citations.sources.insert", "citations.sources.update", "citations.sources.remove", "citations.bibliography.get", "citations.bibliography.insert", "citations.bibliography.rebuild", "citations.bibliography.configure", "citations.bibliography.remove", "authorities.list", "authorities.get", "authorities.insert", "authorities.configure", "authorities.rebuild", "authorities.remove", "authorities.entries.list", "authorities.entries.get", "authorities.entries.insert", "authorities.entries.update", "authorities.entries.remove", "diff.capture", "diff.compare", "diff.apply", "export.toDocx", "protection.get", "protection.setEditingRestriction", "protection.clearEditingRestriction", "permissionRanges.list", "permissionRanges.get", "permissionRanges.create", "permissionRanges.remove", "permissionRanges.updatePrincipal", "customXml.parts.list", "customXml.parts.get", "customXml.parts.create", "customXml.parts.patch", "customXml.parts.remove", "metadata.attach", "metadata.list", "metadata.get", "metadata.update", "metadata.remove", "metadata.resolve" ] }, "planEngine": { "type": "object", "properties": { "supportedStepOps": { "type": "array", "items": { "type": "string" } }, "supportedNonUniformStrategies": { "type": "array", "items": { "type": "string" } }, "supportedSetMarks": { "type": "array", "items": { "type": "string" } }, "regex": { "type": "object", "properties": { "maxPatternLength": { "type": "integer", "description": "Maximum allowed regex pattern length for text selectors." }, "maxExecutionMs": { "type": "integer", "description": "Advisory regex execution budget in milliseconds. Not enforced at runtime: a synchronous RegExp cannot be interrupted, so engines guard with pre-execution static checks instead." } }, "additionalProperties": false, "required": [ "maxPatternLength" ], "description": "Regex selector limits enforced by the selector engine. Unsafe patterns are rejected." } }, "additionalProperties": false, "required": [ "supportedStepOps", "supportedNonUniformStrategies", "supportedSetMarks", "regex" ] } }, "additionalProperties": false, "required": [ "global", "format", "operations", "planEngine" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - None # Create operations Structured creation helpers. ## create.paragraph - Member path: `doc.create.paragraph(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a CreateParagraphResult with the new paragraph block ID and address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "at": { "description": "Position: {kind:'documentEnd'} to append, {kind:'documentStart'} to prepend, or {kind:'before'|'after', target:{kind:'block', nodeType:'...', nodeId:'...'}} for relative placement.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] } ] }, "text": { "type": "string", "description": "Paragraph text content. Each call creates ONE paragraph. For multiple items (e.g. list items), call superdoc_create separately for each item: do NOT use newlines to put multiple items in one paragraph." } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "paragraph": { "$ref": "#/$defs/ParagraphAddress" }, "insertionPoint": { "$ref": "#/$defs/TextAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } }, "ref": { "type": "string", "description": "Ref handle for the created block. Pass directly to superdoc_format or superdoc_edit ref param without searching." } }, "additionalProperties": false, "required": [ "success", "paragraph", "insertionPoint" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## create.heading - Member path: `doc.create.heading(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a CreateHeadingResult with the new heading block ID and address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "level": { "type": "integer", "minimum": 1, "maximum": 6, "description": "Heading level (1-6)." }, "at": { "description": "Position: {kind:'documentEnd'} to append, {kind:'documentStart'} to prepend, or {kind:'before'|'after', target:{kind:'block', nodeType:'...', nodeId:'...'}} for relative placement.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] } ] }, "text": { "type": "string", "description": "Heading text content." } }, "additionalProperties": false, "required": [ "level" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "heading": { "$ref": "#/$defs/HeadingAddress" }, "insertionPoint": { "$ref": "#/$defs/TextAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } }, "ref": { "type": "string", "description": "Ref handle for the created block. Pass directly to superdoc_format or superdoc_edit ref param without searching." } }, "additionalProperties": false, "required": [ "success", "heading", "insertionPoint" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## create.sectionBreak - Member path: `doc.create.sectionBreak(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CreateSectionBreakResult with the new section break position and section address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "at": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] } ] }, "representation": { "enum": [ "asNewParagraph", "attachToPreviousParagraph" ] }, "breakType": { "enum": [ "continuous", "nextPage", "evenPage", "oddPage" ] }, "pageMargins": { "type": "object", "properties": { "top": { "type": "number", "minimum": 0 }, "right": { "type": "number", "minimum": 0 }, "bottom": { "type": "number", "minimum": 0 }, "left": { "type": "number", "minimum": 0 }, "gutter": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "headerFooterMargins": { "type": "object", "properties": { "header": { "type": "number", "minimum": 0 }, "footer": { "type": "number", "minimum": 0 } }, "additionalProperties": false } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" }, "breakParagraph": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## create.table - Member path: `doc.create.table(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a CreateTableResult with the new table block ID and address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "rows": { "type": "integer", "minimum": 1 }, "columns": { "type": "integer", "minimum": 1 }, "at": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "inParagraph" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "offset": { "type": "integer", "minimum": 0 }, "coordinateSpace": { "enum": [ "visible", "tracked" ] } }, "additionalProperties": false, "required": [ "kind", "target", "offset" ] } ] } }, "additionalProperties": false, "required": [ "rows", "columns" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success", "table" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` ## create.tableOfContents - Member path: `doc.create.tableOfContents(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CreateTableOfContentsResult with the new TOC block address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "at": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] } ] }, "config": { "type": "object", "properties": { "outlineLevels": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "useAppliedOutlineLevel": { "type": "boolean" }, "tcFieldIdentifier": { "type": "string" }, "tcFieldLevels": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "hyperlinks": { "type": "boolean" }, "hideInWebView": { "type": "boolean" }, "omitPageNumberLevels": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "separator": { "type": "string" }, "includePageNumbers": { "type": "boolean" }, "tabLeader": { "enum": [ "none", "dot", "hyphen", "underscore", "middleDot" ] }, "rightAlignPageNumbers": { "type": "boolean" } }, "additionalProperties": false }, "instruction": { "type": "string" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "toc": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfContents" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "toc" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_INSERTION_CONTEXT", "PAGE_NUMBERS_NOT_MATERIALIZED" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `INVALID_TARGET` - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` - `INVALID_INSERTION_CONTEXT` ## create.image - Member path: `doc.create.image(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a CreateImageResult with the new image address. Tracked-mode results include `trackedChangeRefs` pointing at the tracked insertion review entity. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "src": { "type": "string" }, "alt": { "type": "string" }, "title": { "type": "string" }, "size": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "additionalProperties": false }, "at": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "inParagraph" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "kind", "target" ] } ] } }, "additionalProperties": false, "required": [ "src" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` - `INVALID_INPUT` # Sections operations Section structure and page-setup operations. ## sections.list - Member path: `doc.sections.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a SectionsListResult with an ordered array of section summaries and their target handles. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "PageInfo": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "returned": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "limit", "offset", "returned" ] } }, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "type": "object", "properties": { "ref": { "type": "string" }, "refStability": { "const": "ephemeral" }, "targetKind": { "const": "section" } }, "additionalProperties": false, "required": [ "ref", "refStability", "targetKind" ] }, "address": { "$ref": "#/$defs/SectionAddress" }, "index": { "type": "integer", "minimum": 0 }, "range": { "type": "object", "properties": { "startParagraphIndex": { "type": "integer", "minimum": 0 }, "endParagraphIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "startParagraphIndex", "endParagraphIndex" ] }, "breakType": { "enum": [ "continuous", "nextPage", "evenPage", "oddPage" ] }, "pageSetup": { "type": "object", "properties": { "width": { "type": "number", "minimum": 0 }, "height": { "type": "number", "minimum": 0 }, "orientation": { "enum": [ "portrait", "landscape" ] }, "paperSize": { "type": "string" } }, "additionalProperties": false }, "margins": { "type": "object", "properties": { "top": { "type": "number", "minimum": 0 }, "right": { "type": "number", "minimum": 0 }, "bottom": { "type": "number", "minimum": 0 }, "left": { "type": "number", "minimum": 0 }, "gutter": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "headerFooterMargins": { "type": "object", "properties": { "header": { "type": "number", "minimum": 0 }, "footer": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "columns": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 1 }, "gap": { "type": "number", "minimum": 0 }, "equalWidth": { "type": "boolean" } }, "additionalProperties": false }, "lineNumbering": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "countBy": { "type": "integer", "minimum": 1 }, "start": { "type": "integer", "minimum": 1 }, "distance": { "type": "number", "minimum": 0 }, "restart": { "enum": [ "continuous", "newPage", "newSection" ] } }, "additionalProperties": false, "required": [ "enabled" ] }, "pageNumbering": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 1 }, "format": { "enum": [ "decimal", "lowerLetter", "upperLetter", "lowerRoman", "upperRoman", "numberInDash" ] }, "chapterStyle": { "type": "integer", "minimum": 1 }, "chapterSeparator": { "type": "string", "enum": [ "hyphen", "period", "colon", "emDash", "enDash" ] } }, "additionalProperties": false }, "titlePage": { "type": "boolean" }, "oddEvenHeadersFooters": { "type": "boolean" }, "verticalAlign": { "enum": [ "top", "center", "bottom", "both" ] }, "sectionDirection": { "enum": [ "ltr", "rtl" ] }, "headerRefs": { "type": "object", "properties": { "default": { "type": "string" }, "first": { "type": "string" }, "even": { "type": "string" } }, "additionalProperties": false }, "footerRefs": { "type": "object", "properties": { "default": { "type": "string" }, "first": { "type": "string" }, "even": { "type": "string" } }, "additionalProperties": false }, "pageBorders": { "type": "object", "properties": { "display": { "enum": [ "allPages", "firstPage", "notFirstPage" ] }, "offsetFrom": { "enum": [ "page", "text" ] }, "zOrder": { "enum": [ "front", "back" ] }, "top": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] }, "right": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] }, "bottom": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] }, "left": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] } }, "additionalProperties": false, "oneOf": [ { "required": [ "display" ] }, { "required": [ "offsetFrom" ] }, { "required": [ "zOrder" ] }, { "required": [ "top" ] }, { "required": [ "right" ] }, { "required": [ "bottom" ] }, { "required": [ "left" ] } ] } }, "additionalProperties": false, "required": [ "id", "handle", "address", "index", "range" ] } }, "page": { "$ref": "#/$defs/PageInfo" } }, "additionalProperties": false, "required": [ "evaluatedRevision", "total", "items", "page" ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## sections.get - Member path: `doc.sections.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a SectionInfo object with full section properties including margins, columns, and header/footer refs. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "address": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "address" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "address": { "$ref": "#/$defs/SectionAddress" }, "index": { "type": "integer", "minimum": 0 }, "range": { "type": "object", "properties": { "startParagraphIndex": { "type": "integer", "minimum": 0 }, "endParagraphIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "startParagraphIndex", "endParagraphIndex" ] }, "breakType": { "enum": [ "continuous", "nextPage", "evenPage", "oddPage" ] }, "pageSetup": { "type": "object", "properties": { "width": { "type": "number", "minimum": 0 }, "height": { "type": "number", "minimum": 0 }, "orientation": { "enum": [ "portrait", "landscape" ] }, "paperSize": { "type": "string" } }, "additionalProperties": false }, "margins": { "type": "object", "properties": { "top": { "type": "number", "minimum": 0 }, "right": { "type": "number", "minimum": 0 }, "bottom": { "type": "number", "minimum": 0 }, "left": { "type": "number", "minimum": 0 }, "gutter": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "headerFooterMargins": { "type": "object", "properties": { "header": { "type": "number", "minimum": 0 }, "footer": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "columns": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 1 }, "gap": { "type": "number", "minimum": 0 }, "equalWidth": { "type": "boolean" } }, "additionalProperties": false }, "lineNumbering": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "countBy": { "type": "integer", "minimum": 1 }, "start": { "type": "integer", "minimum": 1 }, "distance": { "type": "number", "minimum": 0 }, "restart": { "enum": [ "continuous", "newPage", "newSection" ] } }, "additionalProperties": false, "required": [ "enabled" ] }, "pageNumbering": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 1 }, "format": { "enum": [ "decimal", "lowerLetter", "upperLetter", "lowerRoman", "upperRoman", "numberInDash" ] }, "chapterStyle": { "type": "integer", "minimum": 1 }, "chapterSeparator": { "type": "string", "enum": [ "hyphen", "period", "colon", "emDash", "enDash" ] } }, "additionalProperties": false }, "titlePage": { "type": "boolean" }, "oddEvenHeadersFooters": { "type": "boolean" }, "verticalAlign": { "enum": [ "top", "center", "bottom", "both" ] }, "sectionDirection": { "enum": [ "ltr", "rtl" ] }, "headerRefs": { "type": "object", "properties": { "default": { "type": "string" }, "first": { "type": "string" }, "even": { "type": "string" } }, "additionalProperties": false }, "footerRefs": { "type": "object", "properties": { "default": { "type": "string" }, "first": { "type": "string" }, "even": { "type": "string" } }, "additionalProperties": false }, "pageBorders": { "type": "object", "properties": { "display": { "enum": [ "allPages", "firstPage", "notFirstPage" ] }, "offsetFrom": { "enum": [ "page", "text" ] }, "zOrder": { "enum": [ "front", "back" ] }, "top": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] }, "right": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] }, "bottom": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] }, "left": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] } }, "additionalProperties": false, "oneOf": [ { "required": [ "display" ] }, { "required": [ "offsetFrom" ] }, { "required": [ "zOrder" ] }, { "required": [ "top" ] }, { "required": [ "right" ] }, { "required": [ "bottom" ] }, { "required": [ "left" ] } ] } }, "additionalProperties": false, "required": [ "address", "index", "range" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## sections.setBreakType - Member path: `doc.sections.setBreakType(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if the section already has the requested break type. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "breakType": { "enum": [ "continuous", "nextPage", "evenPage", "oddPage" ] } }, "additionalProperties": false, "required": [ "target", "breakType" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setPageMargins - Member path: `doc.sections.setPageMargins(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if margins already match the requested values. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "top": { "type": "number", "minimum": 0 }, "right": { "type": "number", "minimum": 0 }, "bottom": { "type": "number", "minimum": 0 }, "left": { "type": "number", "minimum": 0 }, "gutter": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "target" ], "oneOf": [ { "required": [ "target", "top" ] }, { "required": [ "target", "right" ] }, { "required": [ "target", "bottom" ] }, { "required": [ "target", "left" ] }, { "required": [ "target", "gutter" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setHeaderFooterMargins - Member path: `doc.sections.setHeaderFooterMargins(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if header/footer margins already match the requested values. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "header": { "type": "number", "minimum": 0 }, "footer": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "target" ], "oneOf": [ { "required": [ "target", "header" ] }, { "required": [ "target", "footer" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setPageSetup - Member path: `doc.sections.setPageSetup(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if page size and orientation already match the requested values. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "width": { "type": "number", "minimum": 0 }, "height": { "type": "number", "minimum": 0 }, "orientation": { "enum": [ "portrait", "landscape" ] }, "paperSize": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "target" ], "oneOf": [ { "required": [ "target", "width" ] }, { "required": [ "target", "height" ] }, { "required": [ "target", "orientation" ] }, { "required": [ "target", "paperSize" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setColumns - Member path: `doc.sections.setColumns(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if column configuration already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "count": { "type": "integer", "minimum": 1 }, "gap": { "type": "number", "minimum": 0 }, "equalWidth": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target" ], "oneOf": [ { "required": [ "target", "count" ] }, { "required": [ "target", "gap" ] }, { "required": [ "target", "equalWidth" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setLineNumbering - Member path: `doc.sections.setLineNumbering(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if line numbering settings already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "enabled": { "type": "boolean" }, "countBy": { "type": "integer", "minimum": 1 }, "start": { "type": "integer", "minimum": 1 }, "distance": { "type": "number", "minimum": 0 }, "restart": { "enum": [ "continuous", "newPage", "newSection" ] } }, "additionalProperties": false, "required": [ "target", "enabled" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setPageNumbering - Member path: `doc.sections.setPageNumbering(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if page numbering settings already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "start": { "type": "integer", "minimum": 1 }, "format": { "enum": [ "decimal", "lowerLetter", "upperLetter", "lowerRoman", "upperRoman", "numberInDash" ] }, "chapterStyle": { "type": "integer", "minimum": 1 }, "chapterSeparator": { "type": "string", "enum": [ "hyphen", "period", "colon", "emDash", "enDash" ] } }, "additionalProperties": false, "required": [ "target" ], "anyOf": [ { "required": [ "target", "start" ] }, { "required": [ "target", "format" ] }, { "required": [ "target", "chapterStyle" ] }, { "required": [ "target", "chapterSeparator" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setTitlePage - Member path: `doc.sections.setTitlePage(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if the title-page setting already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "enabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target", "enabled" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setOddEvenHeadersFooters - Member path: `doc.sections.setOddEvenHeadersFooters(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a DocumentMutationResult (not SectionMutationResult) because odd/even headers-footers is a document-level setting, not per-section. Reports NO_OP if the setting already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "enabled" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `CAPABILITY_UNAVAILABLE` ## sections.setVerticalAlign - Member path: `doc.sections.setVerticalAlign(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if vertical alignment already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "value": { "enum": [ "top", "center", "bottom", "both" ] } }, "additionalProperties": false, "required": [ "target", "value" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setSectionDirection - Member path: `doc.sections.setSectionDirection(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if text direction already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "direction": { "enum": [ "ltr", "rtl" ] } }, "additionalProperties": false, "required": [ "target", "direction" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setHeaderFooterRef - Member path: `doc.sections.setHeaderFooterRef(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if the header/footer reference already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "kind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "refId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "target", "kind", "variant", "refId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.clearHeaderFooterRef - Member path: `doc.sections.clearHeaderFooterRef(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if no reference exists for the specified variant. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "kind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] } }, "additionalProperties": false, "required": [ "target", "kind", "variant" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setLinkToPrevious - Member path: `doc.sections.setLinkToPrevious(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if link-to-previous already matches the requested value. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "kind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "linked": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target", "kind", "variant", "linked" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.setPageBorders - Member path: `doc.sections.setPageBorders(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if page border configuration already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" }, "borders": { "type": "object", "properties": { "display": { "enum": [ "allPages", "firstPage", "notFirstPage" ] }, "offsetFrom": { "enum": [ "page", "text" ] }, "zOrder": { "enum": [ "front", "back" ] }, "top": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] }, "right": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] }, "bottom": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] }, "left": { "type": "object", "properties": { "style": { "type": "string" }, "size": { "type": "number", "minimum": 0 }, "space": { "type": "number", "minimum": 0 }, "color": { "type": "string" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ] } }, "additionalProperties": false, "oneOf": [ { "required": [ "display" ] }, { "required": [ "offsetFrom" ] }, { "required": [ "zOrder" ] }, { "required": [ "top" ] }, { "required": [ "right" ] }, { "required": [ "bottom" ] }, { "required": [ "left" ] } ] } }, "additionalProperties": false, "required": [ "target", "borders" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## sections.clearPageBorders - Member path: `doc.sections.clearPageBorders(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if no page borders are configured on the section. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` # Format operations Canonical formatting mutation with directive semantics ('on', 'off', 'clear'). ## formatRange - Member path: `doc.formatRange(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming inline styles were applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "in": { "$ref": "#/$defs/StoryLocator" }, "properties": { "type": "object", "properties": { "bold": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "italic": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "strike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "underline": { "oneOf": [ { "type": "boolean" }, { "type": "null" }, { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "themeColor": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 } ] }, "highlight": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "fontFamily": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "letterSpacing": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vertAlign": { "oneOf": [ { "enum": [ "superscript", "subscript", "baseline" ] }, { "type": "null" } ] }, "position": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "dstrike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "smallCaps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "caps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shading": { "oneOf": [ { "type": "object", "properties": { "fill": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "border": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "sz": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "space": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "outline": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shadow": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "emboss": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "imprint": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "charScale": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "kerning": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "webHidden": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "specVanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rtl": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "bCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "iCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "eastAsianLayout": { "oneOf": [ { "type": "object", "properties": { "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "combine": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "combineBrackets": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "vert": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "vertCompress": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "em": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fitText": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "snapToGrid": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "lang": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "bidi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "oMath": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rStyle": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "rFonts": { "oneOf": [ { "type": "object", "properties": { "ascii": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "asciiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsiaTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "csTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hint": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "fontSizeCs": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "ligatures": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numForm": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numSpacing": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "stylisticSets": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "val": { "type": "boolean" } }, "required": [ "id" ], "additionalProperties": false }, "minItems": 1 }, { "type": "null" } ] }, "contextualAlternates": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1, "description": "Inline formatting properties to apply. Set a property to apply it, use null to clear it. Example: {bold: true, italic: true} or {bold: null} to remove bold." }, "changeMode": { "enum": [ "direct", "tracked" ], "description": "Edit mode: 'direct' applies changes immediately, 'tracked' records tracked formatting." }, "dryRun": { "type": "boolean", "description": "Preview the result without mutating the document." }, "expectedRevision": { "type": "string", "description": "Document revision for optimistic concurrency. Mutation fails if document was modified since this revision." } }, "additionalProperties": false, "required": [ "target", "properties" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "in": { "$ref": "#/$defs/StoryLocator" }, "properties": { "type": "object", "properties": { "bold": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "italic": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "strike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "underline": { "oneOf": [ { "type": "boolean" }, { "type": "null" }, { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "themeColor": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 } ] }, "highlight": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "fontFamily": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "letterSpacing": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vertAlign": { "oneOf": [ { "enum": [ "superscript", "subscript", "baseline" ] }, { "type": "null" } ] }, "position": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "dstrike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "smallCaps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "caps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shading": { "oneOf": [ { "type": "object", "properties": { "fill": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "border": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "sz": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "space": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "outline": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shadow": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "emboss": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "imprint": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "charScale": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "kerning": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "webHidden": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "specVanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rtl": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "bCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "iCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "eastAsianLayout": { "oneOf": [ { "type": "object", "properties": { "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "combine": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "combineBrackets": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "vert": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "vertCompress": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "em": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fitText": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "snapToGrid": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "lang": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "bidi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "oMath": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rStyle": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "rFonts": { "oneOf": [ { "type": "object", "properties": { "ascii": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "asciiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsiaTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "csTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hint": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "fontSizeCs": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "ligatures": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numForm": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numSpacing": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "stylisticSets": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "val": { "type": "boolean" } }, "required": [ "id" ], "additionalProperties": false }, "minItems": 1 }, { "type": "null" } ] }, "contextualAlternates": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1, "description": "Inline formatting properties to apply. Set a property to apply it, use null to clear it. Example: {bold: true, italic: true} or {bold: null} to remove bold." }, "changeMode": { "enum": [ "direct", "tracked" ], "description": "Edit mode: 'direct' applies changes immediately, 'tracked' records tracked formatting." }, "dryRun": { "type": "boolean", "description": "Preview the result without mutating the document." }, "expectedRevision": { "type": "string", "description": "Document revision for optimistic concurrency. Mutation fails if document was modified since this revision." } }, "additionalProperties": false, "required": [ "ref", "properties" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## format.apply - Member path: `doc.format.apply(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming inline styles were applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "in": { "$ref": "#/$defs/StoryLocator" }, "inline": { "type": "object", "properties": { "bold": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "italic": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "strike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "underline": { "oneOf": [ { "type": "boolean" }, { "type": "null" }, { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "themeColor": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 } ] }, "highlight": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "fontFamily": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "letterSpacing": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vertAlign": { "oneOf": [ { "enum": [ "superscript", "subscript", "baseline" ] }, { "type": "null" } ] }, "position": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "dstrike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "smallCaps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "caps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shading": { "oneOf": [ { "type": "object", "properties": { "fill": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "border": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "sz": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "space": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "outline": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shadow": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "emboss": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "imprint": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "charScale": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "kerning": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "webHidden": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "specVanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rtl": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "bCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "iCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "eastAsianLayout": { "oneOf": [ { "type": "object", "properties": { "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "combine": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "combineBrackets": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "vert": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "vertCompress": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "em": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fitText": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "snapToGrid": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "lang": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "bidi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "oMath": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rStyle": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "rFonts": { "oneOf": [ { "type": "object", "properties": { "ascii": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "asciiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsiaTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "csTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hint": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "fontSizeCs": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "ligatures": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numForm": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numSpacing": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "stylisticSets": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "val": { "type": "boolean" } }, "required": [ "id" ], "additionalProperties": false }, "minItems": 1 }, { "type": "null" } ] }, "contextualAlternates": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1, "description": "Inline formatting properties to apply. Set a property to apply it, use null to clear it. Example: {bold: true, italic: true} or {bold: null} to remove bold." } }, "additionalProperties": false, "required": [ "target", "inline" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "in": { "$ref": "#/$defs/StoryLocator" }, "inline": { "type": "object", "properties": { "bold": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "italic": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "strike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "underline": { "oneOf": [ { "type": "boolean" }, { "type": "null" }, { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "themeColor": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 } ] }, "highlight": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "fontFamily": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "letterSpacing": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vertAlign": { "oneOf": [ { "enum": [ "superscript", "subscript", "baseline" ] }, { "type": "null" } ] }, "position": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "dstrike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "smallCaps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "caps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shading": { "oneOf": [ { "type": "object", "properties": { "fill": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "border": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "sz": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "space": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "outline": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shadow": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "emboss": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "imprint": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "charScale": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "kerning": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "webHidden": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "specVanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rtl": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "bCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "iCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "eastAsianLayout": { "oneOf": [ { "type": "object", "properties": { "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "combine": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "combineBrackets": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "vert": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "vertCompress": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "em": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fitText": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "snapToGrid": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "lang": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "bidi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "oMath": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rStyle": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "rFonts": { "oneOf": [ { "type": "object", "properties": { "ascii": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "asciiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsiaTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "csTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hint": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "fontSizeCs": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "ligatures": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numForm": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numSpacing": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "stylisticSets": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "val": { "type": "boolean" } }, "required": [ "id" ], "additionalProperties": false }, "minItems": 1 }, { "type": "null" } ] }, "contextualAlternates": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1, "description": "Inline formatting properties to apply. Set a property to apply it, use null to clear it. Example: {bold: true, italic: true} or {bold: null} to remove bold." } }, "additionalProperties": false, "required": [ "ref", "inline" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## format.bold - Member path: `doc.format.bold(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.italic - Member path: `doc.format.italic(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.strike - Member path: `doc.format.strike(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.underline - Member path: `doc.format.underline(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" }, { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "themeColor": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" }, { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "themeColor": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.highlight - Member path: `doc.format.highlight(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.color - Member path: `doc.format.color(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.fontSize - Member path: `doc.format.fontSize(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.fontFamily - Member path: `doc.format.fontFamily(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.letterSpacing - Member path: `doc.format.letterSpacing(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.vertAlign - Member path: `doc.format.vertAlign(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "enum": [ "superscript", "subscript", "baseline" ] }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "enum": [ "superscript", "subscript", "baseline" ] }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.position - Member path: `doc.format.position(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.dstrike - Member path: `doc.format.dstrike(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.smallCaps - Member path: `doc.format.smallCaps(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.caps - Member path: `doc.format.caps(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.shading - Member path: `doc.format.shading(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "object", "properties": { "fill": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "object", "properties": { "fill": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.border - Member path: `doc.format.border(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "sz": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "space": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "sz": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "space": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.outline - Member path: `doc.format.outline(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.shadow - Member path: `doc.format.shadow(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.emboss - Member path: `doc.format.emboss(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.imprint - Member path: `doc.format.imprint(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.charScale - Member path: `doc.format.charScale(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.kerning - Member path: `doc.format.kerning(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.vanish - Member path: `doc.format.vanish(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.webHidden - Member path: `doc.format.webHidden(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.specVanish - Member path: `doc.format.specVanish(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.rtl - Member path: `doc.format.rtl(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming only the inline run property patch was applied to the target range; paragraph direction is unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.cs - Member path: `doc.format.cs(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.bCs - Member path: `doc.format.bCs(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.iCs - Member path: `doc.format.iCs(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.eastAsianLayout - Member path: `doc.format.eastAsianLayout(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "object", "properties": { "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "combine": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "combineBrackets": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "vert": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "vertCompress": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "object", "properties": { "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "combine": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "combineBrackets": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "vert": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "vertCompress": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.em - Member path: `doc.format.em(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.fitText - Member path: `doc.format.fitText(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.snapToGrid - Member path: `doc.format.snapToGrid(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.lang - Member path: `doc.format.lang(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "bidi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "bidi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.oMath - Member path: `doc.format.oMath(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.rStyle - Member path: `doc.format.rStyle(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.rFonts - Member path: `doc.format.rFonts(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "object", "properties": { "ascii": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "asciiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsiaTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "csTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hint": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "object", "properties": { "ascii": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "asciiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsiaTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "csTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hint": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.fontSizeCs - Member path: `doc.format.fontSizeCs(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.ligatures - Member path: `doc.format.ligatures(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.numForm - Member path: `doc.format.numForm(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.numSpacing - Member path: `doc.format.numSpacing(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.stylisticSets - Member path: `doc.format.stylisticSets(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "val": { "type": "boolean" } }, "required": [ "id" ], "additionalProperties": false }, "minItems": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "value" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "val": { "type": "boolean" } }, "required": [ "id" ], "additionalProperties": false }, "minItems": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref", "value" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` ## format.contextualAlternates - Member path: `doc.format.contextualAlternates(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TextMutationReceipt confirming the inline run property patch was applied to the target range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget", "description": "Selection target: {kind:'selection', start:{kind:'text', blockId, offset}, end:{kind:'text', blockId, offset}}. Use 'ref' instead when you have a search result handle." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "ref": { "type": "string", "description": "Handle ref string from a superdoc_search result. Pass the handle.ref value directly (e.g. 'text:eyJ...'). Preferred over 'target' for inline formatting." }, "value": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "ref" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextMutationSuccess": { "type": "object", "properties": { "success": { "const": true }, "resolution": { "$ref": "#/$defs/TextMutationResolution" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "effects": { "$ref": "#/$defs/ReceiptEffects" } }, "additionalProperties": false, "required": [ "success", "resolution" ] }, "TextMutationResolution": { "type": "object", "properties": { "requestedTarget": { "$ref": "#/$defs/TextAddress" }, "target": { "$ref": "#/$defs/TextAddress" }, "range": { "$ref": "#/$defs/TextMutationRange" }, "text": { "type": "string" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "target", "range", "text" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextMutationRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "ReceiptEffects": { "type": "object", "properties": { "insertedText": { "type": "array", "items": { "$ref": "#/$defs/TextMutationEffect" } }, "insertedBlocks": { "type": "array", "items": { "$ref": "#/$defs/BlockMutationEffect" } } }, "additionalProperties": false }, "TextMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedText" }, "target": { "$ref": "#/$defs/TextAddress" }, "selectionTarget": { "$ref": "#/$defs/SelectionTarget" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "target", "selectionTarget", "text" ] }, "BlockMutationEffect": { "type": "object", "properties": { "kind": { "const": "insertedBlock" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "insertedText": { "$ref": "#/$defs/TextMutationEffect" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "$ref": "#/$defs/TextMutationSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "$ref": "#/$defs/TextMutationResolution" } }, "additionalProperties": false, "required": [ "success", "failure", "resolution" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_TARGET` # Styles operations Document-level stylesheet mutations (docDefaults, style definitions). ## styles.apply - Member path: `doc.styles.apply(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a StylesApplyReceipt with per-channel success/failure details for each property change. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "target": { "type": "object", "properties": { "scope": { "const": "docDefaults" }, "channel": { "const": "run" } }, "additionalProperties": false, "required": [ "scope", "channel" ] }, "patch": { "type": "object", "properties": { "bold": { "type": "boolean" }, "boldCs": { "type": "boolean" }, "italic": { "type": "boolean" }, "iCs": { "type": "boolean" }, "smallCaps": { "type": "boolean" }, "strike": { "type": "boolean" }, "dstrike": { "type": "boolean" }, "emboss": { "type": "boolean" }, "imprint": { "type": "boolean" }, "outline": { "type": "boolean" }, "shadow": { "type": "boolean" }, "vanish": { "type": "boolean" }, "webHidden": { "type": "boolean" }, "specVanish": { "type": "boolean" }, "snapToGrid": { "type": "boolean" }, "noProof": { "type": "boolean" }, "fontSize": { "type": "integer" }, "fontSizeCs": { "type": "integer" }, "letterSpacing": { "type": "integer" }, "kern": { "type": "integer" }, "position": { "type": "integer" }, "w": { "type": "integer", "minimum": 1, "maximum": 600 }, "textTransform": { "enum": [ "uppercase", "none" ] }, "vertAlign": { "enum": [ "superscript", "subscript", "baseline" ] }, "em": { "enum": [ "none", "dot", "comma", "circle", "sesame" ] }, "effect": { "type": "string", "minLength": 1 }, "fontFamily": { "type": "object", "properties": { "hint": { "type": "string", "minLength": 1 }, "ascii": { "type": "string", "minLength": 1 }, "hAnsi": { "type": "string", "minLength": 1 }, "eastAsia": { "type": "string", "minLength": 1 }, "cs": { "type": "string", "minLength": 1 }, "val": { "type": "string", "minLength": 1 }, "asciiTheme": { "type": "string", "minLength": 1 }, "hAnsiTheme": { "type": "string", "minLength": 1 }, "eastAsiaTheme": { "type": "string", "minLength": 1 }, "cstheme": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "color": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "underline": { "type": "object", "properties": { "val": { "enum": [ "single", "double", "thick", "dotted", "dottedHeavy", "dash", "dashedHeavy", "dashLong", "dashLongHeavy", "dotDash", "dashDotHeavy", "dotDotDash", "dashDotDotHeavy", "wave", "wavyHeavy", "wavyDouble", "words", "none" ] }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "borders": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "shading": { "type": "object", "properties": { "color": { "type": "string", "minLength": 1 }, "fill": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeFill": { "type": "string", "minLength": 1 }, "themeFillShade": { "type": "string", "minLength": 1 }, "themeFillTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "val": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "lang": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "eastAsia": { "type": "string", "minLength": 1 }, "bidi": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "eastAsianLayout": { "type": "object", "properties": { "id": { "type": "integer" }, "combine": { "type": "boolean" }, "combineBrackets": { "type": "string", "minLength": 1 }, "vert": { "type": "boolean" }, "vertCompress": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "fitText": { "type": "object", "properties": { "val": { "type": "integer" }, "id": { "type": "integer" } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "required": [ "target", "patch" ] }, { "type": "object", "properties": { "target": { "type": "object", "properties": { "scope": { "const": "docDefaults" }, "channel": { "const": "paragraph" } }, "additionalProperties": false, "required": [ "scope", "channel" ] }, "patch": { "type": "object", "properties": { "keepLines": { "type": "boolean" }, "keepNext": { "type": "boolean" }, "widowControl": { "type": "boolean" }, "contextualSpacing": { "type": "boolean" }, "pageBreakBefore": { "type": "boolean" }, "suppressAutoHyphens": { "type": "boolean" }, "suppressLineNumbers": { "type": "boolean" }, "suppressOverlap": { "type": "boolean" }, "mirrorIndents": { "type": "boolean" }, "wordWrap": { "type": "boolean" }, "kinsoku": { "type": "boolean" }, "overflowPunct": { "type": "boolean" }, "topLinePunct": { "type": "boolean" }, "autoSpaceDE": { "type": "boolean" }, "autoSpaceDN": { "type": "boolean" }, "adjustRightInd": { "type": "boolean" }, "rightToLeft": { "type": "boolean" }, "snapToGrid": { "type": "boolean" }, "outlineLvl": { "type": "integer", "minimum": 0, "maximum": 9 }, "justification": { "enum": [ "left", "center", "right", "justify", "distribute" ] }, "textAlignment": { "enum": [ "top", "center", "baseline", "bottom", "auto" ] }, "textDirection": { "enum": [ "lrTb", "tbRl", "btLr", "lrTbV", "tbRlV", "tbLrV" ] }, "textboxTightWrap": { "enum": [ "none", "allLines", "firstAndLastLine", "firstLineOnly", "lastLineOnly" ] }, "spacing": { "type": "object", "properties": { "after": { "type": "integer" }, "afterAutospacing": { "type": "boolean" }, "afterLines": { "type": "integer" }, "before": { "type": "integer" }, "beforeAutospacing": { "type": "boolean" }, "beforeLines": { "type": "integer" }, "line": { "type": "integer" }, "lineRule": { "enum": [ "auto", "exact", "atLeast" ] } }, "additionalProperties": false, "minProperties": 1 }, "indent": { "type": "object", "properties": { "end": { "type": "integer" }, "endChars": { "type": "integer" }, "firstLine": { "type": "integer" }, "firstLineChars": { "type": "integer" }, "hanging": { "type": "integer" }, "hangingChars": { "type": "integer" }, "left": { "type": "integer" }, "leftChars": { "type": "integer" }, "right": { "type": "integer" }, "rightChars": { "type": "integer" }, "start": { "type": "integer" }, "startChars": { "type": "integer" } }, "additionalProperties": false, "minProperties": 1 }, "shading": { "type": "object", "properties": { "color": { "type": "string", "minLength": 1 }, "fill": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeFill": { "type": "string", "minLength": 1 }, "themeFillShade": { "type": "string", "minLength": 1 }, "themeFillTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "val": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "numberingProperties": { "type": "object", "properties": { "ilvl": { "type": "integer" }, "numId": { "type": "integer" } }, "additionalProperties": false, "minProperties": 1 }, "framePr": { "type": "object", "properties": { "anchorLock": { "type": "boolean" }, "dropCap": { "type": "string", "minLength": 1 }, "h": { "type": "integer" }, "hAnchor": { "type": "string", "minLength": 1 }, "hRule": { "type": "string", "minLength": 1 }, "hSpace": { "type": "integer" }, "lines": { "type": "integer" }, "vAnchor": { "type": "string", "minLength": 1 }, "vSpace": { "type": "integer" }, "w": { "type": "integer" }, "wrap": { "type": "string", "minLength": 1 }, "x": { "type": "integer" }, "xAlign": { "type": "string", "minLength": 1 }, "y": { "type": "integer" }, "yAlign": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "borders": { "type": "object", "properties": { "top": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "bottom": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "left": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "right": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "between": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "bar": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "themeColor": { "type": "string", "minLength": 1 }, "themeTint": { "type": "string", "minLength": 1 }, "themeShade": { "type": "string", "minLength": 1 }, "size": { "type": "integer" }, "space": { "type": "integer" }, "shadow": { "type": "boolean" }, "frame": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "minProperties": 1 }, "tabStops": { "type": "array", "items": { "type": "object", "properties": { "tab": { "type": "object", "properties": { "tabType": { "type": "string", "minLength": 1 }, "pos": { "type": "integer" }, "leader": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "minProperties": 1 } } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "required": [ "target", "patch" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "changed": { "type": "boolean" }, "resolution": { "type": "object", "properties": { "scope": { "const": "docDefaults" }, "channel": { "enum": [ "run", "paragraph" ] }, "xmlPart": { "const": "word/styles.xml" }, "xmlPath": { "enum": [ "w:styles/w:docDefaults/w:rPrDefault/w:rPr", "w:styles/w:docDefaults/w:pPrDefault/w:pPr" ] } }, "additionalProperties": false, "required": [ "scope", "channel", "xmlPart", "xmlPath" ] }, "dryRun": { "type": "boolean" }, "before": { "type": "object", "properties": { "bold": { "enum": [ "on", "off", "inherit" ] }, "boldCs": { "enum": [ "on", "off", "inherit" ] }, "italic": { "enum": [ "on", "off", "inherit" ] }, "iCs": { "enum": [ "on", "off", "inherit" ] }, "smallCaps": { "enum": [ "on", "off", "inherit" ] }, "strike": { "enum": [ "on", "off", "inherit" ] }, "dstrike": { "enum": [ "on", "off", "inherit" ] }, "emboss": { "enum": [ "on", "off", "inherit" ] }, "imprint": { "enum": [ "on", "off", "inherit" ] }, "outline": { "enum": [ "on", "off", "inherit" ] }, "shadow": { "enum": [ "on", "off", "inherit" ] }, "vanish": { "enum": [ "on", "off", "inherit" ] }, "webHidden": { "enum": [ "on", "off", "inherit" ] }, "specVanish": { "enum": [ "on", "off", "inherit" ] }, "snapToGrid": { "enum": [ "on", "off", "inherit" ] }, "noProof": { "enum": [ "on", "off", "inherit" ] }, "fontSize": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "fontSizeCs": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "letterSpacing": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "kern": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "position": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "w": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "textTransform": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "vertAlign": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "em": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "effect": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "fontFamily": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "color": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "underline": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "borders": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "shading": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "lang": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "eastAsianLayout": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "fitText": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "keepLines": { "enum": [ "on", "off", "inherit" ] }, "keepNext": { "enum": [ "on", "off", "inherit" ] }, "widowControl": { "enum": [ "on", "off", "inherit" ] }, "contextualSpacing": { "enum": [ "on", "off", "inherit" ] }, "pageBreakBefore": { "enum": [ "on", "off", "inherit" ] }, "suppressAutoHyphens": { "enum": [ "on", "off", "inherit" ] }, "suppressLineNumbers": { "enum": [ "on", "off", "inherit" ] }, "suppressOverlap": { "enum": [ "on", "off", "inherit" ] }, "mirrorIndents": { "enum": [ "on", "off", "inherit" ] }, "wordWrap": { "enum": [ "on", "off", "inherit" ] }, "kinsoku": { "enum": [ "on", "off", "inherit" ] }, "overflowPunct": { "enum": [ "on", "off", "inherit" ] }, "topLinePunct": { "enum": [ "on", "off", "inherit" ] }, "autoSpaceDE": { "enum": [ "on", "off", "inherit" ] }, "autoSpaceDN": { "enum": [ "on", "off", "inherit" ] }, "adjustRightInd": { "enum": [ "on", "off", "inherit" ] }, "rightToLeft": { "enum": [ "on", "off", "inherit" ] }, "outlineLvl": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "justification": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textAlignment": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textDirection": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textboxTightWrap": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "spacing": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "indent": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "numberingProperties": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "framePr": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "tabStops": { "oneOf": [ { "type": "array" }, { "const": "inherit" } ] } }, "additionalProperties": false }, "after": { "type": "object", "properties": { "bold": { "enum": [ "on", "off", "inherit" ] }, "boldCs": { "enum": [ "on", "off", "inherit" ] }, "italic": { "enum": [ "on", "off", "inherit" ] }, "iCs": { "enum": [ "on", "off", "inherit" ] }, "smallCaps": { "enum": [ "on", "off", "inherit" ] }, "strike": { "enum": [ "on", "off", "inherit" ] }, "dstrike": { "enum": [ "on", "off", "inherit" ] }, "emboss": { "enum": [ "on", "off", "inherit" ] }, "imprint": { "enum": [ "on", "off", "inherit" ] }, "outline": { "enum": [ "on", "off", "inherit" ] }, "shadow": { "enum": [ "on", "off", "inherit" ] }, "vanish": { "enum": [ "on", "off", "inherit" ] }, "webHidden": { "enum": [ "on", "off", "inherit" ] }, "specVanish": { "enum": [ "on", "off", "inherit" ] }, "snapToGrid": { "enum": [ "on", "off", "inherit" ] }, "noProof": { "enum": [ "on", "off", "inherit" ] }, "fontSize": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "fontSizeCs": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "letterSpacing": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "kern": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "position": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "w": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "textTransform": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "vertAlign": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "em": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "effect": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "fontFamily": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "color": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "underline": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "borders": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "shading": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "lang": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "eastAsianLayout": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "fitText": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "keepLines": { "enum": [ "on", "off", "inherit" ] }, "keepNext": { "enum": [ "on", "off", "inherit" ] }, "widowControl": { "enum": [ "on", "off", "inherit" ] }, "contextualSpacing": { "enum": [ "on", "off", "inherit" ] }, "pageBreakBefore": { "enum": [ "on", "off", "inherit" ] }, "suppressAutoHyphens": { "enum": [ "on", "off", "inherit" ] }, "suppressLineNumbers": { "enum": [ "on", "off", "inherit" ] }, "suppressOverlap": { "enum": [ "on", "off", "inherit" ] }, "mirrorIndents": { "enum": [ "on", "off", "inherit" ] }, "wordWrap": { "enum": [ "on", "off", "inherit" ] }, "kinsoku": { "enum": [ "on", "off", "inherit" ] }, "overflowPunct": { "enum": [ "on", "off", "inherit" ] }, "topLinePunct": { "enum": [ "on", "off", "inherit" ] }, "autoSpaceDE": { "enum": [ "on", "off", "inherit" ] }, "autoSpaceDN": { "enum": [ "on", "off", "inherit" ] }, "adjustRightInd": { "enum": [ "on", "off", "inherit" ] }, "rightToLeft": { "enum": [ "on", "off", "inherit" ] }, "outlineLvl": { "oneOf": [ { "type": "number" }, { "const": "inherit" } ] }, "justification": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textAlignment": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textDirection": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "textboxTightWrap": { "oneOf": [ { "type": "string" }, { "const": "inherit" } ] }, "spacing": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "indent": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "numberingProperties": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "framePr": { "oneOf": [ { "type": "object" }, { "const": "inherit" } ] }, "tabStops": { "oneOf": [ { "type": "array" }, { "const": "inherit" } ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "success", "changed", "resolution", "dryRun", "before", "after" ] }, { "type": "object", "properties": { "success": { "const": false }, "resolution": { "type": "object", "properties": { "scope": { "const": "docDefaults" }, "channel": { "enum": [ "run", "paragraph" ] }, "xmlPart": { "const": "word/styles.xml" }, "xmlPath": { "enum": [ "w:styles/w:docDefaults/w:rPrDefault/w:rPr", "w:styles/w:docDefaults/w:pPrDefault/w:pPr" ] } }, "additionalProperties": false, "required": [ "scope", "channel", "xmlPart", "xmlPath" ] }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "resolution", "failure" ] } ] } ``` ### Pre-apply throws - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `REVISION_MISMATCH` ### Non-applied receipt codes - None ## styles.getCatalog - Member path: `doc.styles.getCatalog(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a StylesGetCatalogResult with the requested view, the full filtered style set, document defaults, per-source status, and diagnostics (including labeled fallbacks and unsupported-option notices). ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "view": { "enum": [ "quickGallery", "recommended", "currentDocument", "all", "inUse" ] }, "types": { "type": "array", "items": { "enum": [ "paragraph", "character", "linked", "table", "numbering" ] } }, "includeHidden": { "type": "boolean" }, "includeLatent": { "type": "boolean" }, "includeUsage": { "type": "boolean" }, "includePreview": { "type": "boolean" }, "includeDiagnostics": { "type": "boolean" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "version": { "const": "style-catalog/v1" }, "revision": { "type": [ "string", "null" ] }, "view": { "enum": [ "quickGallery", "recommended", "currentDocument", "all", "inUse" ] }, "defaults": { "type": "object", "properties": { "paragraphStyleId": { "type": [ "string", "null" ] }, "characterStyleId": { "type": [ "string", "null" ] }, "tableStyleId": { "type": [ "string", "null" ] } }, "additionalProperties": false, "required": [ "paragraphStyleId", "characterStyleId", "tableStyleId" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "paragraph", "character", "linked", "table", "numbering", "unknown" ] }, "custom": { "type": "boolean" }, "builtin": { "type": "boolean" }, "default": { "type": "boolean" }, "basedOn": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] }, "link": { "type": [ "string", "null" ] }, "priority": { "type": [ "integer", "null" ] }, "qFormat": { "type": "boolean" }, "hidden": { "type": "boolean" }, "semiHidden": { "type": "boolean" }, "unhideWhenUsed": { "type": "boolean" }, "locked": { "type": "boolean" }, "provenance": { "enum": [ "authored", "default-floor", "latent" ] }, "visibility": { "type": "object", "properties": { "quickGallery": { "type": "boolean" }, "recommended": { "type": "boolean" }, "all": { "type": "boolean" }, "effectivelyHidden": { "type": "boolean" } }, "additionalProperties": false, "required": [ "quickGallery", "recommended", "all", "effectivelyHidden" ] }, "usage": { "type": "object", "properties": { "used": { "type": "boolean" }, "paragraphCount": { "type": "integer", "minimum": 0 }, "runCount": { "type": "integer", "minimum": 0 }, "tableCount": { "type": "integer", "minimum": 0 }, "numberingCount": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "used" ] }, "preview": { "type": "object", "properties": { "available": { "type": "boolean" }, "css": { "type": "object" }, "unsupportedReason": { "type": "string" } }, "additionalProperties": false, "required": [ "available" ] } }, "additionalProperties": false, "required": [ "id", "name", "aliases", "type", "custom", "builtin", "default", "basedOn", "next", "link", "priority", "qFormat", "hidden", "semiHidden", "unhideWhenUsed", "locked", "provenance", "visibility" ] } }, "styles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "paragraph", "character", "linked", "table", "numbering", "unknown" ] }, "custom": { "type": "boolean" }, "builtin": { "type": "boolean" }, "default": { "type": "boolean" }, "basedOn": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] }, "link": { "type": [ "string", "null" ] }, "priority": { "type": [ "integer", "null" ] }, "qFormat": { "type": "boolean" }, "hidden": { "type": "boolean" }, "semiHidden": { "type": "boolean" }, "unhideWhenUsed": { "type": "boolean" }, "locked": { "type": "boolean" }, "provenance": { "enum": [ "authored", "default-floor", "latent" ] }, "visibility": { "type": "object", "properties": { "quickGallery": { "type": "boolean" }, "recommended": { "type": "boolean" }, "all": { "type": "boolean" }, "effectivelyHidden": { "type": "boolean" } }, "additionalProperties": false, "required": [ "quickGallery", "recommended", "all", "effectivelyHidden" ] }, "usage": { "type": "object", "properties": { "used": { "type": "boolean" }, "paragraphCount": { "type": "integer", "minimum": 0 }, "runCount": { "type": "integer", "minimum": 0 }, "tableCount": { "type": "integer", "minimum": 0 }, "numberingCount": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "used" ] }, "preview": { "type": "object", "properties": { "available": { "type": "boolean" }, "css": { "type": "object" }, "unsupportedReason": { "type": "string" } }, "additionalProperties": false, "required": [ "available" ] } }, "additionalProperties": false, "required": [ "id", "name", "aliases", "type", "custom", "builtin", "default", "basedOn", "next", "link", "priority", "qFormat", "hidden", "semiHidden", "unhideWhenUsed", "locked", "provenance", "visibility" ] } }, "sourceStatus": { "type": "object", "properties": { "styles": { "enum": [ "present", "missing", "malformed" ] }, "settings": { "enum": [ "present", "missing", "malformed" ] }, "usage": { "enum": [ "unsupported", "complete", "partial", "failed" ] }, "preview": { "enum": [ "unsupported", "available" ] }, "view": { "enum": [ "supported", "unsupported" ] } }, "additionalProperties": false, "required": [ "styles", "settings", "usage", "preview", "view" ] }, "diagnostics": { "type": "array", "items": { "type": "object", "properties": { "severity": { "enum": [ "info", "warning", "error" ] }, "code": { "type": "string" }, "part": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false, "required": [ "severity", "code", "message" ] } } }, "additionalProperties": false, "required": [ "version", "revision", "view", "defaults", "items", "styles", "sourceStatus", "diagnostics" ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Lists operations List inspection and list mutations. ## lists.list - Member path: `doc.lists.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ListsListResult with an array of list item summaries and total count. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "within": { "$ref": "#/$defs/BlockNodeAddress" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "kind": { "enum": [ "ordered", "bullet" ] }, "level": { "type": "integer" }, "ordinal": { "type": "integer" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ResolvedHandle": { "type": "object", "properties": { "ref": { "type": "string" }, "refStability": { "enum": [ "stable", "ephemeral" ] }, "targetKind": { "$ref": "#/$defs/TargetKind" } }, "additionalProperties": false, "required": [ "ref", "refStability", "targetKind" ] }, "TargetKind": { "anyOf": [ { "enum": [ "text", "node", "list", "comment", "trackedChange", "table", "tableCell", "tableOfContents", "section", "sdt", "field" ] }, { "type": "string", "pattern": "^ext:.+$" } ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "PageInfo": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "returned": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "limit", "offset", "returned" ] } }, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "$ref": "#/$defs/ResolvedHandle" }, "address": { "$ref": "#/$defs/ListItemAddress" }, "listId": { "type": "string" }, "marker": { "type": "string" }, "ordinal": { "type": "integer" }, "path": { "type": "array", "items": { "type": "integer" } }, "level": { "type": "integer" }, "kind": { "enum": [ "ordered", "bullet" ] }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "handle", "address", "listId" ] } }, "page": { "$ref": "#/$defs/PageInfo" } }, "additionalProperties": false, "required": [ "evaluatedRevision", "total", "items", "page" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - None ## lists.get - Member path: `doc.lists.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ListItemInfo object with the item kind, level, marker, and address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "address": { "$ref": "#/$defs/ListItemAddress" } }, "additionalProperties": false, "required": [ "address" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "address": { "$ref": "#/$defs/ListItemAddress" }, "listId": { "type": "string" }, "marker": { "type": "string" }, "ordinal": { "type": "integer" }, "path": { "type": "array", "items": { "type": "integer" } }, "level": { "type": "integer" }, "kind": { "enum": [ "ordered", "bullet" ] }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "address", "listId" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` ### Non-applied receipt codes - None ## lists.insert - Member path: `doc.lists.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ListsInsertResult with the new list item address and block ID. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress", "description": "The target list item. For 'insert': the item to insert relative to. For 'create' with mode 'fromParagraphs': use nodeType 'paragraph' instead. Format: {kind:'block', nodeType:'listItem', nodeId:''}." }, "position": { "enum": [ "before", "after" ], "description": "Required. Insert position relative to target: 'before' or 'after'." }, "text": { "type": "string", "description": "Text content for the new list item." } }, "additionalProperties": false, "required": [ "target", "position" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "insertionPoint": { "$ref": "#/$defs/TextAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item", "insertionPoint" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` ## lists.create - Member path: `doc.lists.create(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsCreateResult with the new listId and the first item address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "BlockAddressOrRange": { "oneOf": [ { "$ref": "#/$defs/BlockAddress" }, { "$ref": "#/$defs/BlockRange" } ] }, "BlockRange": { "type": "object", "properties": { "from": { "$ref": "#/$defs/BlockAddress" }, "to": { "$ref": "#/$defs/BlockAddress" } }, "additionalProperties": false, "required": [ "from", "to" ] } }, "type": "object", "properties": { "mode": { "enum": [ "empty", "fromParagraphs" ], "description": "Required. 'fromParagraphs' converts existing paragraphs into list items: each paragraph becomes one item, so create one paragraph per item first. 'empty' creates a new empty list at 'at'." }, "at": { "$ref": "#/$defs/BlockAddress", "description": "Required when mode is 'empty'. The paragraph to create the list at. Format: {kind:'block', nodeType:'paragraph', nodeId:''}." }, "target": { "$ref": "#/$defs/BlockAddressOrRange", "description": "Required when mode is 'fromParagraphs'. Each call converts ONE paragraph into a list item. To make a list with N items, create N separate paragraphs first, then call superdoc_list create for EACH one. Format: {kind:'block', nodeType:'paragraph', nodeId:''}." }, "kind": { "enum": [ "ordered", "bullet" ], "description": "List type: 'bullet' for bullet points, 'ordered' for numbered lists." }, "level": { "type": "integer", "minimum": 0, "maximum": 8, "description": "List nesting level (0-8). 0 is the top level." }, "preset": { "enum": [ "decimal", "decimalParenthesis", "lowerLetter", "lowerLetterParenthesis", "upperLetter", "upperLetterParenthesis", "lowerRoman", "upperRoman", "disc", "circle", "square", "dash" ], "description": "Predefined list style preset. Overrides 'kind' with a specific numbering or bullet format." }, "style": { "type": "object", "properties": { "version": { "const": 1 }, "levels": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "numFmt": { "type": "string" }, "lvlText": { "type": "string" }, "start": { "type": "integer" }, "alignment": { "enum": [ "left", "center", "right" ] }, "indents": { "type": "object", "properties": { "left": { "type": "integer" }, "hanging": { "type": "integer" }, "firstLine": { "type": "integer" } }, "additionalProperties": false }, "trailingCharacter": { "enum": [ "tab", "space", "nothing" ] }, "markerFont": { "type": "string" }, "pictureBulletId": { "type": "integer" }, "tabStopAt": { "type": [ "integer", "null" ] } }, "additionalProperties": false, "required": [ "level" ] } } }, "additionalProperties": false, "required": [ "version", "levels" ] }, "sequence": { "oneOf": [ { "type": "object", "properties": { "mode": { "const": "new" }, "startAt": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "mode" ] }, { "type": "object", "properties": { "mode": { "const": "continuePrevious" } }, "additionalProperties": false, "required": [ "mode" ] } ] } }, "required": [ "mode" ], "additionalProperties": false, "allOf": [ { "if": { "properties": { "mode": { "const": "empty" } } }, "then": { "required": [ "mode", "at" ] }, "else": { "required": [ "mode", "target" ] } }, { "if": { "properties": { "sequence": { "properties": { "mode": { "const": "continuePrevious" } }, "required": [ "mode" ] } }, "required": [ "sequence" ] }, "then": { "not": { "anyOf": [ { "required": [ "preset" ] }, { "required": [ "style" ] } ] } } } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "listId": { "type": "string" }, "item": { "$ref": "#/$defs/ListItemAddress" } }, "additionalProperties": false, "required": [ "success", "listId", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "LEVEL_OUT_OF_RANGE", "INVALID_INPUT", "NO_COMPATIBLE_PREVIOUS" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` - `INVALID_INPUT` - `NO_COMPATIBLE_PREVIOUS` ## lists.attach - Member path: `doc.lists.attach(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult confirming attachment. Tracked-mode results include `trackedChangeRefs` pointing at the pPrChange-backed numPr revision. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockAddressOrRange": { "oneOf": [ { "$ref": "#/$defs/BlockAddress" }, { "$ref": "#/$defs/BlockRange" } ] }, "BlockAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "BlockRange": { "type": "object", "properties": { "from": { "$ref": "#/$defs/BlockAddress" }, "to": { "$ref": "#/$defs/BlockAddress" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/BlockAddressOrRange" }, "attachTo": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 } }, "additionalProperties": false, "required": [ "target", "attachTo" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "NO_OP", "PRECONDITION_FAILED" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` - `PRECONDITION_FAILED` ## lists.detach - Member path: `doc.lists.detach(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsDetachResult confirming the item was converted to a plain paragraph. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "paragraph": { "$ref": "#/$defs/ParagraphAddress" } }, "additionalProperties": false, "required": [ "success", "paragraph" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` ## lists.delete - Member path: `doc.lists.delete(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsDeleteResult with `deletedCount` (number of items removed). Reports failure (INVALID_TARGET) if the target is not a list item. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "deletedCount": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "success", "deletedCount" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` ## lists.indent - Member path: `doc.lists.indent(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the item is already at maximum indent level. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` ## lists.outdent - Member path: `doc.lists.outdent(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the item is already at the root level. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` ## lists.join - Member path: `doc.lists.join(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsJoinResult with the resulting listId of the merged sequence. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "direction": { "enum": [ "withPrevious", "withNext" ] } }, "additionalProperties": false, "required": [ "target", "direction" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "listId": { "type": "string" } }, "additionalProperties": false, "required": [ "success", "listId" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "NO_ADJACENT_SEQUENCE", "INCOMPATIBLE_DEFINITIONS", "ALREADY_SAME_SEQUENCE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_ADJACENT_SEQUENCE` - `INCOMPATIBLE_DEFINITIONS` - `ALREADY_SAME_SEQUENCE` ## lists.canJoin - Member path: `doc.lists.canJoin(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ListsCanJoinResult indicating feasibility and reason if not possible. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "direction": { "enum": [ "withPrevious", "withNext" ] } }, "additionalProperties": false, "required": [ "target", "direction" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "canJoin": { "type": "boolean" }, "reason": { "enum": [ "NO_ADJACENT_SEQUENCE", "INCOMPATIBLE_DEFINITIONS", "ALREADY_SAME_SEQUENCE" ] }, "adjacentListId": { "type": "string" } }, "additionalProperties": false, "required": [ "canJoin" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - None ## lists.separate - Member path: `doc.lists.separate(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsSeparateResult with the new listId and numId. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "copyOverrides": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "listId": { "type": "string" }, "numId": { "type": "integer" } }, "additionalProperties": false, "required": [ "success", "listId", "numId" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## lists.merge - Member path: `doc.lists.merge(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMergeResult with the merged listId, absorbedCount, and removedEmptyBlocks count. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "direction": { "enum": [ "withPrevious", "withNext" ] } }, "additionalProperties": false, "required": [ "target", "direction" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "listId": { "type": "string" }, "absorbedCount": { "type": "integer" }, "removedEmptyBlocks": { "type": "integer" } }, "additionalProperties": false, "required": [ "success", "listId", "absorbedCount", "removedEmptyBlocks" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "NO_ADJACENT_SEQUENCE", "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_ADJACENT_SEQUENCE` - `NO_OP` ## lists.split - Member path: `doc.lists.split(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsSplitResult with the new listId, numId, and the restart value applied (or null). ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "restartNumbering": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "listId": { "type": "string" }, "numId": { "type": "integer" }, "restartedAt": { "type": [ "integer", "null" ] } }, "additionalProperties": false, "required": [ "success", "listId", "numId", "restartedAt" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## lists.setLevel - Member path: `doc.lists.setLevel(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if already at the target level. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 } }, "additionalProperties": false, "required": [ "target", "level" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "LEVEL_OUT_OF_RANGE", "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` - `NO_OP` ## lists.setValue - Member path: `doc.lists.setValue(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "value": { "type": [ "integer", "null" ] } }, "additionalProperties": false, "required": [ "target", "value" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## lists.continuePrevious - Member path: `doc.lists.continuePrevious(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "NO_COMPATIBLE_PREVIOUS", "ALREADY_CONTINUOUS" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_COMPATIBLE_PREVIOUS` - `ALREADY_CONTINUOUS` ## lists.canContinuePrevious - Member path: `doc.lists.canContinuePrevious(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ListsCanContinuePreviousResult indicating feasibility. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "canContinue": { "type": "boolean" }, "reason": { "enum": [ "NO_PREVIOUS_LIST", "INCOMPATIBLE_DEFINITIONS", "ALREADY_CONTINUOUS" ] }, "previousListId": { "type": "string" } }, "additionalProperties": false, "required": [ "canContinue" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - None ## lists.setLevelRestart - Member path: `doc.lists.setLevelRestart(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "restartAfterLevel": { "type": [ "integer", "null" ] }, "scope": { "enum": [ "definition", "instance" ] } }, "additionalProperties": false, "required": [ "target", "level", "restartAfterLevel" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "LEVEL_OUT_OF_RANGE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` ## lists.convertToText - Member path: `doc.lists.convertToText(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsConvertToTextResult confirming the conversion. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "includeMarker": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "paragraph": { "$ref": "#/$defs/ParagraphAddress" } }, "additionalProperties": false, "required": [ "success", "paragraph" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` ## lists.applyTemplate - Member path: `doc.lists.applyTemplate(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if all levels already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "template": { "type": "object", "properties": { "version": { "const": 1 }, "levels": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "numFmt": { "type": "string" }, "lvlText": { "type": "string" }, "start": { "type": "integer" }, "alignment": { "enum": [ "left", "center", "right" ] }, "indents": { "type": "object", "properties": { "left": { "type": "integer" }, "hanging": { "type": "integer" }, "firstLine": { "type": "integer" } }, "additionalProperties": false }, "trailingCharacter": { "enum": [ "tab", "space", "nothing" ] }, "markerFont": { "type": "string" }, "pictureBulletId": { "type": "integer" } }, "additionalProperties": false, "required": [ "level" ] } } }, "additionalProperties": false, "required": [ "version", "levels" ] }, "levels": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 8 } } }, "additionalProperties": false, "required": [ "target", "template" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` - `INVALID_INPUT` ## lists.applyPreset - Member path: `doc.lists.applyPreset(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if all levels already match the preset. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "preset": { "enum": [ "decimal", "decimalParenthesis", "lowerLetter", "lowerLetterParenthesis", "upperLetter", "upperLetterParenthesis", "lowerRoman", "upperRoman", "disc", "circle", "square", "dash" ] }, "levels": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 8 } } }, "additionalProperties": false, "required": [ "target", "preset" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` - `INVALID_INPUT` ## lists.setType - Member path: `doc.lists.setType(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the list is already the requested kind and no sequences were merged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "kind": { "enum": [ "ordered", "bullet" ] }, "continuity": { "enum": [ "preserve", "none" ], "description": "Numbering continuity: 'preserve' keeps numbering; 'none' restarts." } }, "additionalProperties": false, "required": [ "target", "kind" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `INVALID_INPUT` ## lists.captureTemplate - Member path: `doc.lists.captureTemplate(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ListsCaptureTemplateResult containing the captured template. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "levels": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 8 } } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "template": { "type": "object", "properties": { "version": { "const": 1 }, "levels": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "numFmt": { "type": "string" }, "lvlText": { "type": "string" }, "start": { "type": "integer" }, "alignment": { "enum": [ "left", "center", "right" ] }, "indents": { "type": "object", "properties": { "left": { "type": "integer" }, "hanging": { "type": "integer" }, "firstLine": { "type": "integer" } }, "additionalProperties": false }, "trailingCharacter": { "enum": [ "tab", "space", "nothing" ] }, "markerFont": { "type": "string" }, "pictureBulletId": { "type": "integer" } }, "additionalProperties": false, "required": [ "level" ] } } }, "additionalProperties": false, "required": [ "version", "levels" ] } }, "additionalProperties": false, "required": [ "success", "template" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "INVALID_INPUT", "LEVEL_OUT_OF_RANGE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `INVALID_TARGET` - `INVALID_INPUT` - `LEVEL_OUT_OF_RANGE` ## lists.setLevelNumbering - Member path: `doc.lists.setLevelNumbering(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the level already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "numFmt": { "type": "string" }, "lvlText": { "type": "string" }, "start": { "type": "integer" } }, "additionalProperties": false, "required": [ "target", "level", "numFmt", "lvlText" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE", "LEVEL_NOT_FOUND" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` - `LEVEL_NOT_FOUND` ## lists.setLevelBullet - Member path: `doc.lists.setLevelBullet(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the marker already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "markerText": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "level", "markerText" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE", "LEVEL_NOT_FOUND" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` - `LEVEL_NOT_FOUND` ## lists.setLevelPictureBullet - Member path: `doc.lists.setLevelPictureBullet(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the picture bullet already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "pictureBulletId": { "type": "integer" } }, "additionalProperties": false, "required": [ "target", "level", "pictureBulletId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE", "LEVEL_NOT_FOUND", "INVALID_INPUT", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` - `LEVEL_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ## lists.setLevelAlignment - Member path: `doc.lists.setLevelAlignment(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the alignment already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "alignment": { "enum": [ "left", "center", "right" ] } }, "additionalProperties": false, "required": [ "target", "level", "alignment" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE", "LEVEL_NOT_FOUND" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` - `LEVEL_NOT_FOUND` ## lists.setLevelIndents - Member path: `doc.lists.setLevelIndents(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if all indent values already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "left": { "type": "integer" }, "hanging": { "type": "integer" }, "firstLine": { "type": "integer" } }, "required": [ "target", "level" ], "additionalProperties": false, "anyOf": [ { "required": [ "left" ] }, { "required": [ "hanging" ] }, { "required": [ "firstLine" ] } ], "not": { "required": [ "hanging", "firstLine" ] } } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE", "LEVEL_NOT_FOUND", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` - `LEVEL_NOT_FOUND` - `INVALID_INPUT` ## lists.setLevelTrailingCharacter - Member path: `doc.lists.setLevelTrailingCharacter(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the trailing character already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "trailingCharacter": { "enum": [ "tab", "space", "nothing" ] } }, "additionalProperties": false, "required": [ "target", "level", "trailingCharacter" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE", "LEVEL_NOT_FOUND" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` - `LEVEL_NOT_FOUND` ## lists.setLevelMarkerFont - Member path: `doc.lists.setLevelMarkerFont(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the font already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "fontFamily": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "level", "fontFamily" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE", "LEVEL_NOT_FOUND" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` - `LEVEL_NOT_FOUND` ## lists.clearLevelOverrides - Member path: `doc.lists.clearLevelOverrides(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if no override exists. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 } }, "additionalProperties": false, "required": [ "target", "level" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "LEVEL_OUT_OF_RANGE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `LEVEL_OUT_OF_RANGE` ## lists.getStyle - Member path: `doc.lists.getStyle(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ListsGetStyleResult containing the captured style. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "levels": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 8 } } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "style": { "type": "object", "properties": { "version": { "const": 1 }, "levels": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "numFmt": { "type": "string" }, "lvlText": { "type": "string" }, "start": { "type": "integer" }, "alignment": { "enum": [ "left", "center", "right" ] }, "indents": { "type": "object", "properties": { "left": { "type": "integer" }, "hanging": { "type": "integer" }, "firstLine": { "type": "integer" } }, "additionalProperties": false }, "trailingCharacter": { "enum": [ "tab", "space", "nothing" ] }, "markerFont": { "type": "string" }, "pictureBulletId": { "type": "integer" }, "tabStopAt": { "type": [ "integer", "null" ] } }, "additionalProperties": false, "required": [ "level" ] } } }, "additionalProperties": false, "required": [ "version", "levels" ] } }, "additionalProperties": false, "required": [ "success", "style" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "INVALID_INPUT", "LEVEL_OUT_OF_RANGE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `INVALID_TARGET` - `INVALID_INPUT` - `LEVEL_OUT_OF_RANGE` ## lists.applyStyle - Member path: `doc.lists.applyStyle(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if all levels already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "style": { "type": "object", "properties": { "version": { "const": 1 }, "levels": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "numFmt": { "type": "string" }, "lvlText": { "type": "string" }, "start": { "type": "integer" }, "alignment": { "enum": [ "left", "center", "right" ] }, "indents": { "type": "object", "properties": { "left": { "type": "integer" }, "hanging": { "type": "integer" }, "firstLine": { "type": "integer" } }, "additionalProperties": false }, "trailingCharacter": { "enum": [ "tab", "space", "nothing" ] }, "markerFont": { "type": "string" }, "pictureBulletId": { "type": "integer" }, "tabStopAt": { "type": [ "integer", "null" ] } }, "additionalProperties": false, "required": [ "level" ] } } }, "additionalProperties": false, "required": [ "version", "levels" ] }, "levels": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 8 } } }, "additionalProperties": false, "required": [ "target", "style" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "INVALID_INPUT", "LEVEL_OUT_OF_RANGE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `INVALID_INPUT` - `LEVEL_OUT_OF_RANGE` ## lists.restartAt - Member path: `doc.lists.restartAt(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "startAt": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "target", "startAt" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `INVALID_INPUT` ## lists.setLevelNumberStyle - Member path: `doc.lists.setLevelNumberStyle(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the value already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "numberStyle": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "level", "numberStyle" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "INVALID_INPUT", "LEVEL_OUT_OF_RANGE", "LEVEL_NOT_FOUND" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `INVALID_INPUT` - `LEVEL_OUT_OF_RANGE` - `LEVEL_NOT_FOUND` ## lists.setLevelText - Member path: `doc.lists.setLevelText(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the value already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "level", "text" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "INVALID_INPUT", "LEVEL_OUT_OF_RANGE", "LEVEL_NOT_FOUND" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `INVALID_INPUT` - `LEVEL_OUT_OF_RANGE` - `LEVEL_NOT_FOUND` ## lists.setLevelStart - Member path: `doc.lists.setLevelStart(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if the value already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "startAt": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "target", "level", "startAt" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "INVALID_INPUT", "LEVEL_OUT_OF_RANGE", "LEVEL_NOT_FOUND" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `INVALID_INPUT` - `LEVEL_OUT_OF_RANGE` - `LEVEL_NOT_FOUND` ## lists.setLevelLayout - Member path: `doc.lists.setLevelLayout(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ListsMutateItemResult receipt; reports NO_OP if all values already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/ListItemAddress" }, "level": { "type": "integer", "minimum": 0, "maximum": 8 }, "layout": { "type": "object", "properties": { "alignment": { "enum": [ "left", "center", "right" ] }, "alignedAt": { "type": "integer" }, "textIndentAt": { "type": "integer" }, "followCharacter": { "enum": [ "tab", "space", "nothing" ] }, "tabStopAt": { "type": [ "integer", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "target", "level", "layout" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "INVALID_INPUT", "LEVEL_OUT_OF_RANGE", "LEVEL_NOT_FOUND" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `INVALID_INPUT` - `LEVEL_OUT_OF_RANGE` - `LEVEL_NOT_FOUND` ## lists.getState - Member path: `doc.lists.getState(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ListsGetStateResult with `isListItem` plus numId/ilvl/abstract/numFmt metadata when present. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "isListItem": { "type": "boolean" }, "numId": { "type": [ "string", "null" ] }, "ilvl": { "type": "integer", "minimum": 0 }, "abstractNumId": { "type": [ "string", "null" ] }, "numFmt": { "type": [ "string", "null" ] }, "lvlText": { "type": [ "string", "null" ] }, "seed": { "type": [ "string", "null" ], "enum": [ "bullet", "ordered", null ] } }, "additionalProperties": false, "required": [ "success", "isListItem", "ilvl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ## lists.apply - Member path: `doc.lists.apply(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: no ### Expected result Returns a ListsMutateItemResult receipt with txId; partsChanged includes numbering / content-types / rels when first-list materialization fires. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } ] }, "seed": { "enum": [ "bullet", "ordered" ] }, "reuseNumId": { "type": "string" }, "ilvl": { "type": "integer", "minimum": 0, "maximum": 8 } }, "additionalProperties": false, "required": [ "target", "seed" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_CONTEXT", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `INVALID_TARGET` - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_CONTEXT` - `INVALID_INPUT` ## lists.continue - Member path: `doc.lists.continue(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: no ### Expected result Returns a ListsMutateItemResult receipt with txId. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_CONTEXT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_CONTEXT` ## lists.restart - Member path: `doc.lists.restart(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: no ### Expected result Returns a ListsMutateItemResult receipt with txId; partsChanged includes /word/numbering.xml. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } ] }, "startAt": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_CONTEXT", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `INVALID_TARGET` - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_CONTEXT` - `INVALID_INPUT` ## lists.remove - Member path: `doc.lists.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: no ### Expected result Returns a ListsMutateItemResult receipt with txId. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "item": { "$ref": "#/$defs/ListItemAddress" }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" }, "changed": { "type": "boolean" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "item" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_CONTEXT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_CONTEXT` # Comments operations Comment authoring and thread lifecycle operations. ## comments.create - Member path: `doc.comments.create(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a Receipt with the new commentId in `id` and `inserted` on success; rejects whitespace-only bodies, unsupported anchor contexts, and cross-story targets. Tracked-change comment targets support insertion, deletion, replacement, and paired-move revisions; they fail with `TARGET_NOT_FOUND` for stale ids, `CAPABILITY_UNAVAILABLE` for formatting / structural revisions and unpaired move sides, and `INVALID_TARGET` for incompatible side requests or ambiguous replacement targets that omit a required `side`. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "CommentTrackedChangeTarget": { "type": "object", "properties": { "kind": { "const": "trackedChange", "description": "Optional discriminator. Omit it for the Labs-compatible { trackedChangeId } shape." }, "trackedChangeId": { "type": "string" }, "side": { "enum": [ "inserted", "deleted", "source", "destination" ], "description": "Which revision side to anchor the comment on. Optional for paired replacements (defaults to inserted) and paired moves (defaults to destination); required for independent replacements where both sides are separately reviewable." }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "trackedChangeId" ] } }, "type": "object", "properties": { "text": { "type": "string", "description": "Comment text content." }, "target": { "description": "Text range to anchor the comment. Accepts either a single-block TextAddress {kind:'text', blockId, range}, a multi-segment TextTarget {kind:'text', segments:[{blockId, range}, ...]} for selections that span blocks, a SelectionTarget {kind:'selection', start, end} returned by query.match, a TextSearchCommentTarget {text, story?}, or a TrackedChangeCommentTarget ({kind:'trackedChange', trackedChangeId, side?} or {trackedChangeId, side?}) that names a logical tracked-change id as a convenience anchor .", "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/TextTarget" }, { "$ref": "#/$defs/SelectionTarget" }, { "$ref": "#/$defs/CommentTrackedChangeTarget" }, { "type": "object", "properties": { "text": { "type": "string", "description": "Text to find and anchor the comment to. The adapter resolves the first body/story match." }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "text" ] } ] }, "trackedChangeId": { "type": "string", "description": "Compatibility shorthand for target: { trackedChangeId }. Used only when target is omitted." }, "side": { "enum": [ "inserted", "deleted", "source", "destination" ], "description": "Optional side for the top-level trackedChangeId shorthand." }, "story": { "$ref": "#/$defs/StoryLocator", "description": "Optional story for the top-level trackedChangeId shorthand." }, "parentCommentId": { "type": "string", "description": "Parent comment ID for creating a threaded reply." }, "parentId": { "type": "string", "description": "Public alias for parentCommentId when creating a threaded reply." } }, "additionalProperties": false, "required": [ "text" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "CommentsCreateSuccess": { "type": "object", "properties": { "success": { "const": true }, "id": { "type": "string" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success", "id" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "$ref": "#/$defs/CommentsCreateSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_INPUT", "INVALID_TARGET", "INVALID_CONTEXT", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `INVALID_INPUT` - `INVALID_TARGET` - `INVALID_CONTEXT` - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ## comments.patch - Member path: `doc.comments.patch(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a Receipt with `updated` populated on success. Reports `NO_OP` for byte-identical edits, rejects empty-body / trim-equivalent edits with `INVALID_INPUT`, no-op resolve/reopen/setInternal with `INVALID_INPUT`, reply target/status with `INVALID_CONTEXT`, cross-story moves with `INVALID_CONTEXT`, materializing inherited slot moves with `CAPABILITY_UNAVAILABLE`, stale tracked-change targets with `TARGET_NOT_FOUND`, and formatting / structural / unpaired-move tracked-change targets with `CAPABILITY_UNAVAILABLE`. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "CommentTrackedChangeTarget": { "type": "object", "properties": { "kind": { "const": "trackedChange", "description": "Optional discriminator. Omit it for the Labs-compatible { trackedChangeId } shape." }, "trackedChangeId": { "type": "string" }, "side": { "enum": [ "inserted", "deleted", "source", "destination" ], "description": "Which revision side to anchor the comment on. Optional for paired replacements (defaults to inserted) and paired moves (defaults to destination); required for independent replacements where both sides are separately reviewable." }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "trackedChangeId" ] } }, "type": "object", "properties": { "commentId": { "type": "string" }, "text": { "type": "string", "description": "Updated comment text." }, "target": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/SelectionTarget" }, { "$ref": "#/$defs/CommentTrackedChangeTarget" }, { "type": "object", "properties": { "text": { "type": "string", "description": "Text to find and anchor the comment to. The adapter resolves the first body/story match." }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "text" ] } ], "description": "New anchor for the comment. Accepts a plain TextAddress, a SelectionTarget {kind:'selection', start, end}, a TextSearchCommentTarget {text, story?}, or a TrackedChangeCommentTarget, with or without kind, that names a logical tracked-change id as a convenience re-anchor target ." }, "status": { "enum": [ "resolved", "active" ], "description": "Set comment status. Use 'resolved' to resolve a comment, or 'active' to reopen a previously resolved comment (lifecycle inverse)." }, "isInternal": { "type": "boolean", "description": "Legacy v1/document-api compatibility field. V2 adapters set or clear the target comment `sdcom:internal` attribute and preserve the field in the schema so v1 callers keep their input shape." } }, "additionalProperties": false, "required": [ "commentId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptSuccess": { "type": "object", "properties": { "success": { "const": true }, "id": { "type": "string" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "invalidatedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRef" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" } }, "additionalProperties": false, "required": [ "success" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "$ref": "#/$defs/ReceiptSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_INPUT", "INVALID_TARGET", "INVALID_CONTEXT", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `INVALID_INPUT` - `INVALID_TARGET` - `INVALID_CONTEXT` - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `NO_OP` ## comments.delete - Member path: `doc.comments.delete(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a Receipt with the targeted removed commentId in `removed` and every story touched in `affectedStories`. Rejects with `TARGET_NOT_FOUND` when the comment id does not exist and reports `NO_OP` when the command layer accepts the target but removes nothing. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "commentId": { "type": "string" } }, "additionalProperties": false, "required": [ "commentId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptSuccess": { "type": "object", "properties": { "success": { "const": true }, "id": { "type": "string" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "invalidatedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRef" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" } }, "additionalProperties": false, "required": [ "success" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "$ref": "#/$defs/ReceiptSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `NO_OP` ## comments.get - Member path: `doc.comments.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CommentInfo object with the comment text, author, date, and thread metadata. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "commentId": { "type": "string" } }, "additionalProperties": false, "required": [ "commentId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "CommentTrackedChangeLink": { "type": "object", "properties": { "trackedChange": { "const": true }, "trackedChangeId": { "type": "string" }, "trackedChangeType": { "enum": [ "insertion", "deletion", "replacement", "formatting", "move", "structural", "insert", "delete", "format" ] }, "side": { "enum": [ "inserted", "deleted", "source", "destination" ] }, "trackedChangeText": { "type": "string" }, "insertedText": { "type": "string" }, "deletedText": { "type": "string" } }, "additionalProperties": false, "required": [ "trackedChange", "trackedChangeId", "trackedChangeType" ] } }, "type": "object", "properties": { "address": { "$ref": "#/$defs/CommentAddress" }, "commentId": { "type": "string" }, "importedId": { "type": "string" }, "rawOoxmlId": { "type": "string", "description": "Durable raw OOXML source identity: the comment's w:id exactly as it appears in comments.xml. Surfaced for every catalog-backed comment, even when commentId already equals it on a clean import. Omitted for synthetic comments that never had a comments.xml carrier." }, "rawOoxmlOccurrenceIndex": { "type": "number", "description": "Zero-based source occurrence among comments that share the same rawOoxmlId in comments.xml. Present only for duplicate raw OOXML ids." }, "parentCommentId": { "type": "string" }, "trackedChangeParentId": { "type": "string", "description": "SuperDoc logical tracked-change id when the comment anchor sits wholly inside exactly one active tracked change. Derived on read from the comment anchor index plus the tracked-change catalog." }, "trackedChangeThreadParentId": { "type": "string", "description": "SuperDoc logical tracked-change id whose review conversation this comment explicitly belongs to. Persisted provenance; never inferred from anchor overlap." }, "trackedChangeSide": { "enum": [ "inserted", "deleted", "source", "destination" ], "description": "Which side of the surrounding tracked change the comment anchor sits on. Pairs with `trackedChangeParentId`." }, "text": { "type": "string" }, "isInternal": { "type": "boolean" }, "status": { "enum": [ "open", "resolved" ] }, "target": { "$ref": "#/$defs/TextTarget" }, "anchoredText": { "type": "string" }, "createdTime": { "type": "number" }, "creatorName": { "type": "string" }, "creatorEmail": { "type": "string" }, "trackedChange": { "type": "boolean" }, "trackedChangeType": { "enum": [ "insertion", "deletion", "replacement", "formatting", "move", "structural", "insert", "delete", "format" ] }, "trackedChangeDisplayType": { "type": [ "string", "null" ] }, "trackedChangeStory": { "oneOf": [ { "$ref": "#/$defs/StoryLocator" }, { "type": "null" } ] }, "trackedChangeAnchorKey": { "type": [ "string", "null" ] }, "trackedChangeText": { "type": [ "string", "null" ] }, "insertedText": { "type": [ "string", "null" ] }, "deletedText": { "type": [ "string", "null" ] }, "trackedChangeLink": { "oneOf": [ { "$ref": "#/$defs/CommentTrackedChangeLink" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "address", "commentId", "status" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` ### Non-applied receipt codes - None ## comments.list - Member path: `doc.comments.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CommentsListResult with an array of comment threads and total count. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "includeResolved": { "type": "boolean", "description": "When true, includes resolved comments in results. Default: false." }, "limit": { "type": "integer", "description": "Maximum number of comments to return." }, "offset": { "type": "integer", "description": "Number of comments to skip for pagination." } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ResolvedHandle": { "type": "object", "properties": { "ref": { "type": "string" }, "refStability": { "enum": [ "stable", "ephemeral" ] }, "targetKind": { "$ref": "#/$defs/TargetKind" } }, "additionalProperties": false, "required": [ "ref", "refStability", "targetKind" ] }, "TargetKind": { "anyOf": [ { "enum": [ "text", "node", "list", "comment", "trackedChange", "table", "tableCell", "tableOfContents", "section", "sdt", "field" ] }, { "type": "string", "pattern": "^ext:.+$" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "CommentTrackedChangeLink": { "type": "object", "properties": { "trackedChange": { "const": true }, "trackedChangeId": { "type": "string" }, "trackedChangeType": { "enum": [ "insertion", "deletion", "replacement", "formatting", "move", "structural", "insert", "delete", "format" ] }, "side": { "enum": [ "inserted", "deleted", "source", "destination" ] }, "trackedChangeText": { "type": "string" }, "insertedText": { "type": "string" }, "deletedText": { "type": "string" } }, "additionalProperties": false, "required": [ "trackedChange", "trackedChangeId", "trackedChangeType" ] }, "PageInfo": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "returned": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "limit", "offset", "returned" ] } }, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "$ref": "#/$defs/ResolvedHandle" }, "address": { "$ref": "#/$defs/CommentAddress" }, "importedId": { "type": "string" }, "rawOoxmlId": { "type": "string", "description": "Durable raw OOXML source identity: the comment's w:id exactly as it appears in comments.xml. Surfaced for every catalog-backed comment, even when commentId already equals it on a clean import. Omitted for synthetic comments that never had a comments.xml carrier." }, "rawOoxmlOccurrenceIndex": { "type": "number", "description": "Zero-based source occurrence among comments that share the same rawOoxmlId in comments.xml. Present only for duplicate raw OOXML ids." }, "parentCommentId": { "type": "string" }, "trackedChangeParentId": { "type": "string", "description": "SuperDoc logical tracked-change id when the comment anchor sits wholly inside exactly one active tracked change. Derived on read." }, "trackedChangeThreadParentId": { "type": "string", "description": "SuperDoc logical tracked-change id whose review conversation this comment explicitly belongs to. Persisted provenance; never inferred from anchor overlap." }, "trackedChangeSide": { "enum": [ "inserted", "deleted", "source", "destination" ], "description": "Which side of the surrounding tracked change the comment anchor sits on." }, "text": { "type": "string" }, "isInternal": { "type": "boolean" }, "status": { "enum": [ "open", "resolved" ] }, "target": { "$ref": "#/$defs/TextTarget" }, "anchoredText": { "type": "string" }, "createdTime": { "type": "number" }, "creatorName": { "type": "string" }, "creatorEmail": { "type": "string" }, "trackedChange": { "type": "boolean" }, "trackedChangeType": { "enum": [ "insertion", "deletion", "replacement", "formatting", "move", "structural", "insert", "delete", "format" ] }, "trackedChangeDisplayType": { "type": [ "string", "null" ] }, "trackedChangeStory": { "oneOf": [ { "$ref": "#/$defs/StoryLocator" }, { "type": "null" } ] }, "trackedChangeAnchorKey": { "type": [ "string", "null" ] }, "trackedChangeText": { "type": [ "string", "null" ] }, "insertedText": { "type": [ "string", "null" ] }, "deletedText": { "type": [ "string", "null" ] }, "trackedChangeLink": { "oneOf": [ { "$ref": "#/$defs/CommentTrackedChangeLink" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "id", "handle", "address", "status" ] } }, "page": { "$ref": "#/$defs/PageInfo" } }, "additionalProperties": false, "required": [ "evaluatedRevision", "total", "items", "page" ] } ``` ### Pre-apply throws - `INVALID_INPUT` ### Non-applied receipt codes - None # Track Changes operations Tracked-change inspection and review operations. ## trackChanges.list - Member path: `doc.trackChanges.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a TrackChangesListResult of logical tracked-change entries with SuperDoc ids, semantic type/subtype, author/date/excerpt, revisionGroupId, flat projection fields (`grouping`, `insertedText`, `deletedText`, `formattingDeltaSummary`, `origin`, `imported`, `canonicalizationKind`, `addressKind`, `resolvableById`), optional overlap metadata, and source provenance via `sourceIds` / `wordRevisionIds`. Structural whole-table changes surface subtypes such as `table-insert` and `table-delete`. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "limit": { "type": "integer", "description": "Maximum number of tracked changes to return." }, "offset": { "type": "integer", "description": "Number of tracked changes to skip for pagination." }, "type": { "enum": [ "insertion", "deletion", "replacement", "formatting", "move", "structural", "insert", "delete", "format" ], "description": "Filter by change type. Canonical values: 'insertion', 'deletion', 'replacement', 'formatting', 'move', 'structural'. Legacy aliases 'insert', 'delete', and 'format' remain accepted during migration." }, "in": { "oneOf": [ { "$ref": "#/$defs/StoryLocator" }, { "const": "all" } ], "description": "Story scope. Omit for body only, pass a StoryLocator for a single story, or 'all' for body + every revision-capable non-body story." } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ResolvedHandle": { "type": "object", "properties": { "ref": { "type": "string" }, "refStability": { "enum": [ "stable", "ephemeral" ] }, "targetKind": { "$ref": "#/$defs/TargetKind" } }, "additionalProperties": false, "required": [ "ref", "refStability", "targetKind" ] }, "TargetKind": { "anyOf": [ { "enum": [ "text", "node", "list", "comment", "trackedChange", "table", "tableCell", "tableOfContents", "section", "sdt", "field" ] }, { "type": "string", "pattern": "^ext:.+$" } ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "PageInfo": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "returned": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "limit", "offset", "returned" ] } }, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "$ref": "#/$defs/ResolvedHandle" }, "address": { "$ref": "#/$defs/TrackedChangeAddress" }, "type": { "enum": [ "insertion", "deletion", "replacement", "formatting", "move", "structural", "insert", "delete", "format" ] }, "subtype": { "type": "string" }, "state": { "enum": [ "open", "accepted", "rejected" ] }, "sourceIds": { "type": "object", "properties": { "wordIdInsert": { "type": "string", "description": "Word `w:id` value from the insertion side of this logical change." }, "wordIdDelete": { "type": "string", "description": "Word `w:id` value from the deletion side of this logical change." }, "wordIdOther": { "type": "array", "items": { "type": "string" }, "description": "Word `w:id` values from other wrappers (for example moveFrom/moveTo)." }, "rsids": { "type": "array", "items": { "type": "string" }, "description": "Word revision-save ids (`w:rsidR` / `w:rsidDel`) seen on contributing wrappers." } }, "additionalProperties": false, "description": "Canonical multi-side source provenance. Provenance metadata only; never the canonical SuperDoc tracked-change id." }, "wordRevisionIds": { "type": "object", "properties": { "insert": { "type": "string", "description": "Raw imported Word OOXML revision ID (`w:id`) from a `` element when this logical change includes an insertion." }, "delete": { "type": "string", "description": "Raw imported Word OOXML revision ID (`w:id`) from a `` element when this logical change includes a deletion." }, "format": { "type": "string", "description": "Raw imported Word OOXML revision ID (`w:id`) from a `` element when this logical change includes a formatting revision." } }, "additionalProperties": false, "description": "Raw imported Word OOXML revision IDs (`w:id`) from the source document when available. This is provenance metadata, not the canonical SuperDoc tracked-change ID. Replacements may include both `insert` and `delete` IDs." }, "revisionGroupId": { "type": "string" }, "author": { "type": "string" }, "authorEmail": { "type": "string" }, "authorImage": { "type": "string" }, "initials": { "type": "string" }, "date": { "type": "string" }, "storyLocator": { "$ref": "#/$defs/StoryLocator" }, "excerpt": { "type": "string" }, "grouping": { "enum": [ "standalone", "replacement-pair", "unknown" ] }, "pairedWithChangeId": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "insertedText": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "deletedText": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "formattingDeltaSummary": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-readable formatting delta summary for formatting changes; null otherwise." }, "listDeltas": { "type": "array", "items": { "type": "object", "properties": { "kind": { "enum": [ "list-add", "list-remove", "list-level", "list-style", "list-restart", "indent", "other-format" ], "description": "Semantic list-delta classification for this member (spec TC-LIST-004)." }, "from": { "type": "object", "properties": { "hasNumPr": { "type": "boolean", "description": "Explicit numPr element present in the property block on this side." }, "numId": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Effective list membership numId; non-positive numIds normalize to null." }, "ilvl": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "description": "Explicit ilvl value; null when the source omitted it (effective level 0)." }, "styleKind": { "oneOf": [ { "enum": [ "bullet", "number", "letter", "roman", "other" ] }, { "type": "null" } ], "description": "Resolved visual style kind via the numbering model; null when unresolvable." } }, "additionalProperties": false, "required": [ "hasNumPr", "numId", "ilvl", "styleKind" ] }, "to": { "type": "object", "properties": { "hasNumPr": { "type": "boolean", "description": "Explicit numPr element present in the property block on this side." }, "numId": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Effective list membership numId; non-positive numIds normalize to null." }, "ilvl": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "description": "Explicit ilvl value; null when the source omitted it (effective level 0)." }, "styleKind": { "oneOf": [ { "enum": [ "bullet", "number", "letter", "roman", "other" ] }, { "type": "null" } ], "description": "Resolved visual style kind via the numbering model; null when unresolvable." } }, "additionalProperties": false, "required": [ "hasNumPr", "numId", "ilvl", "styleKind" ] }, "levelDirection": { "enum": [ "indent", "outdent" ], "description": "Direction of a list-level change." }, "restartAt": { "type": "number", "description": "Restart value for a list-restart change (numbering-model derived)." } }, "additionalProperties": false, "required": [ "kind", "from", "to" ] }, "description": "Structured per-member list semantic deltas for tracked list formatting changes (spec TC-LIST-003/004); absent for non-list changes." }, "listDeltaSummary": { "type": "object", "properties": { "uniformKind": { "oneOf": [ { "enum": [ "list-add", "list-remove", "list-level", "list-style", "list-restart", "indent", "other-format" ] }, { "type": "null" } ], "description": "The single delta kind shared by every member, or null for mixed groups." }, "counts": { "type": "object", "properties": { "list-add": { "type": "number" }, "list-remove": { "type": "number" }, "list-level": { "type": "number" }, "list-style": { "type": "number" }, "list-restart": { "type": "number" }, "indent": { "type": "number" }, "other-format": { "type": "number" } }, "additionalProperties": false, "description": "Non-zero member counts per delta kind." } }, "additionalProperties": false, "required": [ "uniformKind", "counts" ] }, "targetIsListItem": { "type": "boolean", "description": "For paragraph-mark structural changes: whether the target paragraph is a direct-numbered list item." }, "listActionKind": { "enum": [ "merge-items" ], "description": "Stable presentation fact on the merge-owner deletion change (spec TC-LIST-005)." }, "origin": { "enum": [ "word", "google-docs", "superdoc", "unknown" ] }, "imported": { "type": "boolean" }, "canonicalizationKind": { "enum": [ "single-word-revision", "paired-word-revision", "generated-runtime-id", "unknown" ] }, "addressKind": { "enum": [ "entity", "story-entity", "unknown" ] }, "resolvableById": { "type": "boolean" }, "overlap": { "type": "object", "properties": { "visualLayers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "SuperDoc logical tracked-change id for this overlap layer." }, "type": { "enum": [ "insertion", "deletion", "replacement", "formatting", "move", "structural", "insert", "delete", "format" ], "description": "Canonical broad tracked-change type for this layer." }, "relationship": { "enum": [ "parent", "child", "standalone" ] } }, "additionalProperties": false, "required": [ "id", "type", "relationship" ] }, "description": "Ordered overlap layers, with the parent surface first and child layers after it." }, "preferredContextTargetId": { "type": "string", "description": "Preferred child tracked-change id for context-menu/comment targeting." }, "preferredContextTarget": { "type": "object", "properties": { "id": { "type": "string", "description": "SuperDoc logical tracked-change id for this overlap layer." }, "type": { "enum": [ "insertion", "deletion", "replacement", "formatting", "move", "structural", "insert", "delete", "format" ], "description": "Canonical broad tracked-change type for this layer." }, "relationship": { "enum": [ "parent", "child", "standalone" ] } }, "additionalProperties": false, "required": [ "id", "type", "relationship" ] }, "relationship": { "enum": [ "parent", "child", "standalone" ] }, "parentId": { "type": "string", "description": "Parent logical tracked-change id when this change is an overlap child." } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "id", "handle", "address", "type" ] } }, "page": { "$ref": "#/$defs/PageInfo" } }, "additionalProperties": false, "required": [ "evaluatedRevision", "total", "items", "page" ] } ``` ### Pre-apply throws - `INVALID_INPUT` ### Non-applied receipt codes - None ## trackChanges.get - Member path: `doc.trackChanges.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a TrackChangeInfo object with the logical id, semantic type/subtype, state, target, before/after snapshots, author/initials/email, date, revisionGroupId, splitFromId, replacement or move side metadata when applicable, story locator, excerpt, optional overlap metadata, and source provenance via `sourceIds` / `wordRevisionIds`. Structural whole-table changes surface subtypes such as `table-insert` and `table-delete`. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "id": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "id" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "address": { "$ref": "#/$defs/TrackedChangeAddress" }, "id": { "type": "string" }, "type": { "enum": [ "insertion", "deletion", "replacement", "formatting", "move", "structural", "insert", "delete", "format" ] }, "subtype": { "type": "string" }, "state": { "enum": [ "open", "accepted", "rejected" ] }, "target": { "oneOf": [ { "type": "object", "properties": { "kind": { "enum": [ "text" ] }, "address": { "$ref": "#/$defs/TrackedChangeAddress" } }, "additionalProperties": false, "required": [ "kind", "address" ] }, { "type": "object", "properties": { "kind": { "enum": [ "replacement" ] }, "address": { "$ref": "#/$defs/TrackedChangeAddress" } }, "additionalProperties": false, "required": [ "kind", "address" ] }, { "type": "object", "properties": { "kind": { "enum": [ "formatting" ] }, "address": { "$ref": "#/$defs/TrackedChangeAddress" }, "subtype": { "enum": [ "run", "paragraph", "list", "table", "row", "cell", "section" ] } }, "additionalProperties": false, "required": [ "kind", "address", "subtype" ] } ] }, "before": { "type": "object", "properties": { "text": { "type": "string", "description": "Visible text snapshot when the affected revision is text-shaped." }, "formatting": { "type": "object", "properties": { "xml": { "type": "string", "description": "Raw OOXML for the property block on this side." }, "properties": { "type": "object", "additionalProperties": true, "description": "Subtype-aware semantic property map for formatting revisions." } }, "additionalProperties": false } }, "additionalProperties": false }, "after": { "type": "object", "properties": { "text": { "type": "string", "description": "Visible text snapshot when the affected revision is text-shaped." }, "formatting": { "type": "object", "properties": { "xml": { "type": "string", "description": "Raw OOXML for the property block on this side." }, "properties": { "type": "object", "additionalProperties": true, "description": "Subtype-aware semantic property map for formatting revisions." } }, "additionalProperties": false } }, "additionalProperties": false }, "sourceIds": { "type": "object", "properties": { "wordIdInsert": { "type": "string", "description": "Word `w:id` value from the insertion side of this logical change." }, "wordIdDelete": { "type": "string", "description": "Word `w:id` value from the deletion side of this logical change." }, "wordIdOther": { "type": "array", "items": { "type": "string" }, "description": "Word `w:id` values from other wrappers (for example moveFrom/moveTo)." }, "rsids": { "type": "array", "items": { "type": "string" }, "description": "Word revision-save ids (`w:rsidR` / `w:rsidDel`) seen on contributing wrappers." } }, "additionalProperties": false, "description": "Canonical multi-side source provenance. Provenance metadata only; never the canonical SuperDoc tracked-change id." }, "wordRevisionIds": { "type": "object", "properties": { "insert": { "type": "string", "description": "Raw imported Word OOXML revision ID (`w:id`) from a `` element when this logical change includes an insertion." }, "delete": { "type": "string", "description": "Raw imported Word OOXML revision ID (`w:id`) from a `` element when this logical change includes a deletion." }, "format": { "type": "string", "description": "Raw imported Word OOXML revision ID (`w:id`) from a `` element when this logical change includes a formatting revision." } }, "additionalProperties": false, "description": "Raw imported Word OOXML revision IDs (`w:id`) from the source document when available. This is provenance metadata, not the canonical SuperDoc tracked-change ID. Replacements may include both `insert` and `delete` IDs." }, "revisionGroupId": { "type": "string" }, "splitFromId": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "replacement": { "type": "object", "properties": { "inserted": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Stable SuperDoc-internal side id." }, "excerpt": { "type": "string", "description": "Visible text excerpt on this side." }, "wordId": { "type": "string", "description": "Raw Word `w:id` for this side, when known." } }, "additionalProperties": false, "required": [ "id", "excerpt" ] }, { "type": "null" } ] }, "deleted": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Stable SuperDoc-internal side id." }, "excerpt": { "type": "string", "description": "Visible text excerpt on this side." }, "wordId": { "type": "string", "description": "Raw Word `w:id` for this side, when known." } }, "additionalProperties": false, "required": [ "id", "excerpt" ] }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "inserted", "deleted" ] }, "author": { "type": "string" }, "authorEmail": { "type": "string" }, "authorImage": { "type": "string" }, "initials": { "type": "string" }, "date": { "type": "string" }, "storyLocator": { "$ref": "#/$defs/StoryLocator" }, "sourcePlatform": { "enum": [ "word", "google-docs", "superdoc", "unknown" ] }, "grouping": { "enum": [ "standalone", "replacement-pair", "unknown" ] }, "pairedWithChangeId": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "insertedText": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "deletedText": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "formattingDeltaSummary": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-readable formatting delta summary for formatting changes; null otherwise." }, "listDeltas": { "type": "array", "items": { "type": "object", "properties": { "kind": { "enum": [ "list-add", "list-remove", "list-level", "list-style", "list-restart", "indent", "other-format" ], "description": "Semantic list-delta classification for this member (spec TC-LIST-004)." }, "from": { "type": "object", "properties": { "hasNumPr": { "type": "boolean", "description": "Explicit numPr element present in the property block on this side." }, "numId": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Effective list membership numId; non-positive numIds normalize to null." }, "ilvl": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "description": "Explicit ilvl value; null when the source omitted it (effective level 0)." }, "styleKind": { "oneOf": [ { "enum": [ "bullet", "number", "letter", "roman", "other" ] }, { "type": "null" } ], "description": "Resolved visual style kind via the numbering model; null when unresolvable." } }, "additionalProperties": false, "required": [ "hasNumPr", "numId", "ilvl", "styleKind" ] }, "to": { "type": "object", "properties": { "hasNumPr": { "type": "boolean", "description": "Explicit numPr element present in the property block on this side." }, "numId": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Effective list membership numId; non-positive numIds normalize to null." }, "ilvl": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "description": "Explicit ilvl value; null when the source omitted it (effective level 0)." }, "styleKind": { "oneOf": [ { "enum": [ "bullet", "number", "letter", "roman", "other" ] }, { "type": "null" } ], "description": "Resolved visual style kind via the numbering model; null when unresolvable." } }, "additionalProperties": false, "required": [ "hasNumPr", "numId", "ilvl", "styleKind" ] }, "levelDirection": { "enum": [ "indent", "outdent" ], "description": "Direction of a list-level change." }, "restartAt": { "type": "number", "description": "Restart value for a list-restart change (numbering-model derived)." } }, "additionalProperties": false, "required": [ "kind", "from", "to" ] }, "description": "Structured per-member list semantic deltas for tracked list formatting changes (spec TC-LIST-003/004); absent for non-list changes." }, "listDeltaSummary": { "type": "object", "properties": { "uniformKind": { "oneOf": [ { "enum": [ "list-add", "list-remove", "list-level", "list-style", "list-restart", "indent", "other-format" ] }, { "type": "null" } ], "description": "The single delta kind shared by every member, or null for mixed groups." }, "counts": { "type": "object", "properties": { "list-add": { "type": "number" }, "list-remove": { "type": "number" }, "list-level": { "type": "number" }, "list-style": { "type": "number" }, "list-restart": { "type": "number" }, "indent": { "type": "number" }, "other-format": { "type": "number" } }, "additionalProperties": false, "description": "Non-zero member counts per delta kind." } }, "additionalProperties": false, "required": [ "uniformKind", "counts" ] }, "targetIsListItem": { "type": "boolean", "description": "For paragraph-mark structural changes: whether the target paragraph is a direct-numbered list item." }, "listActionKind": { "enum": [ "merge-items" ], "description": "Stable presentation fact on the merge-owner deletion change (spec TC-LIST-005)." }, "origin": { "enum": [ "word", "google-docs", "superdoc", "unknown" ] }, "imported": { "type": "boolean" }, "canonicalizationKind": { "enum": [ "single-word-revision", "paired-word-revision", "generated-runtime-id", "unknown" ] }, "addressKind": { "enum": [ "entity", "story-entity", "unknown" ] }, "resolvableById": { "type": "boolean" }, "excerpt": { "type": "string" }, "overlap": { "type": "object", "properties": { "visualLayers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "SuperDoc logical tracked-change id for this overlap layer." }, "type": { "enum": [ "insertion", "deletion", "replacement", "formatting", "move", "structural", "insert", "delete", "format" ], "description": "Canonical broad tracked-change type for this layer." }, "relationship": { "enum": [ "parent", "child", "standalone" ] } }, "additionalProperties": false, "required": [ "id", "type", "relationship" ] }, "description": "Ordered overlap layers, with the parent surface first and child layers after it." }, "preferredContextTargetId": { "type": "string", "description": "Preferred child tracked-change id for context-menu/comment targeting." }, "preferredContextTarget": { "type": "object", "properties": { "id": { "type": "string", "description": "SuperDoc logical tracked-change id for this overlap layer." }, "type": { "enum": [ "insertion", "deletion", "replacement", "formatting", "move", "structural", "insert", "delete", "format" ], "description": "Canonical broad tracked-change type for this layer." }, "relationship": { "enum": [ "parent", "child", "standalone" ] } }, "additionalProperties": false, "required": [ "id", "type", "relationship" ] }, "relationship": { "enum": [ "parent", "child", "standalone" ] }, "parentId": { "type": "string", "description": "Parent logical tracked-change id when this change is an overlap child." } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "address", "id", "type" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` ### Non-applied receipt codes - None ## trackChanges.decide - Member path: `doc.trackChanges.decide(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a Receipt. `removed` lists retired tracked-change ids; `inserted` lists successor fragment ids produced by partial range splits; `invalidatedRefs` lists every retired tracked-change ref plus cascade-deleted comment ids; `remappedRefs` carries surviving comment anchors moved by the decision; `affectedStories` lists touched stories; `textRangeShifts` reports per-story visible-text deltas; `txId` correlates with history. Failures: SPAN_FRAGMENTED when a range crosses an indivisible boundary, CAPABILITY_UNAVAILABLE for formatting / structural / move targets (not yet supported), TARGET_NOT_FOUND for retired ids or zero overlap, STALE_REVISION for stale expectedRevision, REVISION_MISMATCH for stale range coverage, NO_OP when { kind: 'all' } resolves an empty target set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] } }, "type": "object", "properties": { "decision": { "enum": [ "accept", "reject" ] }, "expectedRevision": { "type": "string", "description": "Backward-compatible alias for options.expectedRevision. Explicit mutation options take precedence when both are supplied." }, "target": { "description": "Decision target. Canonical shapes: { kind: 'id', id, story? } (one whole logical tracked change), { kind: 'ids', ids } (several whole logical tracked changes in one atomic history unit), { kind: 'range', range: TextTarget, coordinateSpace?, overlap?, side?, story?, part? } or { kind: 'range', range: { anchor, relativeStart, relativeEnd }, overlap?, side?, story?, part? } (resolves only the selected overlap; may split fragments), { kind: 'all' } (every active tracked change). Legacy { id, story? } / { id, range: { kind: 'partial', start, end } } / { scope: 'all' } shapes are accepted and transparently promoted to canonical targets.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "id" }, "id": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" }, "side": { "enum": [ "insert", "inserted", "delete", "deleted" ] }, "moveRole": { "enum": [ "pair", "source", "destination" ], "description": "Optional move pairing assertion. 'pair' requires the resolved tracked change to be a paired move; 'source' / 'destination' further narrow to a specific half. When the assertion does not hold the decide adapter fails closed." } }, "additionalProperties": false, "required": [ "kind", "id" ] }, { "type": "object", "properties": { "kind": { "const": "ids" }, "ids": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Logical tracked-change ids resolved atomically in one decision and history unit." } }, "additionalProperties": false, "required": [ "kind", "ids" ] }, { "type": "object", "properties": { "kind": { "const": "range" }, "range": { "$ref": "#/$defs/TextTarget" }, "coordinateSpace": { "enum": [ "visible", "tracked" ], "description": "Coordinate space of the TextTarget offsets. Omitted preserves legacy tracked-space behavior." }, "overlap": { "type": "string", "description": "Optional logical overlap selector for callers that already resolved an ambiguous overlap surface. Adapter-owned interpretation." }, "side": { "enum": [ "insert", "inserted", "delete", "deleted", "source", "destination" ], "description": "Optional revision side for paired replacement or move targets." }, "story": { "$ref": "#/$defs/StoryLocator", "description": "Optional story containing the range target." }, "part": { "type": "string", "description": "Compatibility alias used by older range callers; interpretation is adapter-owned." } }, "additionalProperties": false, "required": [ "kind", "range" ] }, { "type": "object", "properties": { "kind": { "const": "range" }, "range": { "type": "object", "properties": { "anchor": { "type": "string" }, "relativeStart": { "type": "integer", "minimum": 0 }, "relativeEnd": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "anchor", "relativeStart", "relativeEnd" ] }, "overlap": { "type": "string", "description": "Optional logical overlap selector for callers that already resolved an ambiguous overlap surface. Adapter-owned interpretation." }, "side": { "enum": [ "insert", "inserted", "delete", "deleted", "source", "destination" ], "description": "Optional revision side for paired replacement or move targets." }, "story": { "$ref": "#/$defs/StoryLocator", "description": "Optional story containing the range target." }, "part": { "type": "string", "description": "Compatibility alias used by older range callers; interpretation is adapter-owned." } }, "additionalProperties": false, "required": [ "kind", "range" ] }, { "type": "object", "properties": { "kind": { "const": "range" }, "anchor": { "type": "string" }, "relativeStart": { "type": "integer", "minimum": 0 }, "relativeEnd": { "type": "integer", "minimum": 0 }, "overlap": { "type": "string", "description": "Optional logical overlap selector for callers that already resolved an ambiguous overlap surface. Adapter-owned interpretation." }, "side": { "enum": [ "insert", "inserted", "delete", "deleted", "source", "destination" ], "description": "Optional revision side for paired replacement or move targets." }, "story": { "$ref": "#/$defs/StoryLocator", "description": "Optional story containing the range target." }, "part": { "type": "string", "description": "Compatibility alias used by older range callers; interpretation is adapter-owned." } }, "additionalProperties": false, "required": [ "kind", "anchor", "relativeStart", "relativeEnd" ] }, { "type": "object", "properties": { "kind": { "const": "all" }, "story": { "oneOf": [ { "$ref": "#/$defs/StoryLocator" }, { "const": "all" } ], "description": "Optional explicit bulk filter. Omit or pass 'all' to target every revision-capable story, or pass a StoryLocator to scope the decision to one story." } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" }, "moveRole": { "enum": [ "pair", "source", "destination" ], "description": "Optional move pairing assertion. 'pair' requires the resolved tracked change to be a paired move; 'source' / 'destination' further narrow to a specific half. When the assertion does not hold the decide adapter fails closed." } }, "additionalProperties": false, "required": [ "id" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "range": { "type": "object", "properties": { "kind": { "const": "partial" }, "start": { "type": "integer", "minimum": 0 }, "end": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "id", "range" ] }, { "type": "object", "properties": { "scope": { "enum": [ "all" ] }, "story": { "oneOf": [ { "$ref": "#/$defs/StoryLocator" }, { "const": "all" } ], "description": "Optional explicit bulk filter. Omit or pass 'all' to target every revision-capable story, or pass a StoryLocator to scope the decision to one story." } }, "additionalProperties": false, "required": [ "scope" ] } ] } }, "required": [ "decision", "target" ], "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptSuccess": { "type": "object", "properties": { "success": { "const": true }, "id": { "type": "string" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "invalidatedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRef" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" } }, "additionalProperties": false, "required": [ "success" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "$ref": "#/$defs/ReceiptSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_INPUT", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "PERMISSION_DENIED", "PRECONDITION_FAILED", "COMMENT_CASCADE_PARTIAL", "SPAN_FRAGMENTED", "STALE_REVISION", "REVISION_MISMATCH" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` - `INVALID_TARGET` ### Non-applied receipt codes - `NO_OP` - `INVALID_INPUT` - `INVALID_TARGET` - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `PERMISSION_DENIED` - `PRECONDITION_FAILED` - `COMMENT_CASCADE_PARTIAL` - `SPAN_FRAGMENTED` - `STALE_REVISION` - `REVISION_MISMATCH` # Query operations Deterministic selector-based queries for mutation targeting. ## query.match - Member path: `doc.query.match(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Usage **Typechecked example:** Find one clause and create a revision-guarded comment. Typechecked against the public Document API. Runtime validation is tracked separately. ```ts import type { DocumentApi } from '@superdoc/document-api'; export async function commentOnOneClause(doc: DocumentApi) { const result = await doc.query.match({ select: { type: 'text', pattern: 'Confidential Information' }, require: 'exactlyOne', }); const match = result.items[0]; if (!match || match.matchKind !== 'text') throw new Error('The clause was not found.'); const receipt = await doc.comments.create( { text: 'Please review this definition.', target: match.target }, { expectedRevision: result.evaluatedRevision }, ); if (!receipt.success) throw new Error(receipt.failure.message); return receipt; } ``` ### Expected result Returns a QueryMatchOutput with the resolved target address and cardinality metadata. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "select": { "description": "Search selector. Use {type:'text', pattern:'...'} for text search or {type:'node', nodeType:'paragraph'|'heading'|...} for node search.", "oneOf": [ { "type": "object", "properties": { "type": { "const": "text", "description": "Must be 'text' for text pattern search." }, "pattern": { "type": "string", "description": "Text to match. In regex mode, patterns are validated for syntax, maximum length, and safety before execution." }, "mode": { "enum": [ "contains", "regex" ], "description": "Match mode: 'contains' (literal substring, recommended for literal text) or 'regex' (validated regular expression)." }, "caseSensitive": { "type": "boolean", "description": "Case-sensitive matching. Default: false." }, "wholeWord": { "type": "boolean", "description": "Require word-boundary matches. Default: false." } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node", "description": "Must be 'node' for node type search." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ], "description": "Block type to match (paragraph, heading, table, listItem, etc.)." }, "kind": { "enum": [ "block", "inline" ], "description": "Filter: 'block' or 'inline'." } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress", "description": "Limit search scope to within a specific block: {kind:'block', nodeType:'...', nodeId:'...'}." }, "require": { "enum": [ "any", "first", "exactlyOne", "all" ], "description": "Match cardinality: 'any' (all matches), 'first' (only first), 'exactlyOne' (fail if != 1), 'all' (fail if 0)." }, "mode": { "enum": [ "strict", "candidates" ], "description": "Search mode: 'strict' (default, exact matching) or 'candidates' (returns scored potential matches)." }, "includeNodes": { "type": "boolean", "description": "When true, includes full node data in results. Default: false." }, "limit": { "type": "integer", "minimum": 1, "description": "Maximum number of matches to return." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of matches to skip for pagination." } }, "additionalProperties": false, "required": [ "select" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ResolvedHandle": { "type": "object", "properties": { "ref": { "type": "string" }, "refStability": { "enum": [ "stable", "ephemeral" ] }, "targetKind": { "$ref": "#/$defs/TargetKind" } }, "additionalProperties": false, "required": [ "ref", "refStability", "targetKind" ] }, "TargetKind": { "anyOf": [ { "enum": [ "text", "node", "list", "comment", "trackedChange", "table", "tableCell", "tableOfContents", "section", "sdt", "field" ] }, { "type": "string", "pattern": "^ext:.+$" } ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "MatchBlock": { "type": "object", "properties": { "blockId": { "type": "string" }, "nodeType": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" }, "text": { "type": "string" }, "paragraphStyle": { "type": "object", "properties": { "styleId": { "type": "string" }, "isListItem": { "type": "boolean" }, "listLevel": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "ref": { "type": "string" }, "runs": { "type": "array", "items": { "$ref": "#/$defs/MatchRun" } } }, "additionalProperties": false, "required": [ "blockId", "nodeType", "range", "text", "ref", "runs" ] }, "MatchRun": { "type": "object", "properties": { "range": { "$ref": "#/$defs/Range" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" }, "text": { "type": "string" }, "styleId": { "type": "string" }, "styles": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "bold": { "enum": [ "on", "off", "clear" ] }, "italic": { "enum": [ "on", "off", "clear" ] }, "underline": { "enum": [ "on", "off", "clear" ] }, "strike": { "enum": [ "on", "off", "clear" ] } }, "additionalProperties": false, "required": [ "bold", "italic", "underline", "strike" ] }, "effective": { "type": "object", "properties": { "bold": { "type": "boolean" }, "italic": { "type": "boolean" }, "underline": { "type": "boolean" }, "strike": { "type": "boolean" } }, "additionalProperties": false, "required": [ "bold", "italic", "underline", "strike" ] }, "color": { "type": "string" }, "highlight": { "type": "string" }, "fontFamily": { "type": "string" }, "fontSizePt": { "type": "number" } }, "additionalProperties": false, "required": [ "direct", "effective" ] }, "ref": { "type": "string" } }, "additionalProperties": false, "required": [ "range", "text", "styles", "ref" ] }, "NodeAddress": { "oneOf": [ { "$ref": "#/$defs/BlockNodeAddress" }, { "$ref": "#/$defs/InlineNodeAddress" } ] }, "InlineNodeAddress": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "enum": [ "run", "bookmark", "comment", "hyperlink", "sdt", "image", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ] }, "anchor": { "$ref": "#/$defs/InlineAnchor" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] }, "PageInfo": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "returned": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "limit", "offset", "returned" ] } }, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "$ref": "#/$defs/ResolvedHandle" }, "matchKind": { "const": "text" }, "address": { "$ref": "#/$defs/BlockNodeAddress" }, "target": { "$ref": "#/$defs/SelectionTarget" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" }, "snippet": { "type": "string" }, "highlightRange": { "$ref": "#/$defs/Range" }, "blocks": { "type": "array", "items": { "$ref": "#/$defs/MatchBlock" }, "minItems": 1 }, "groups": { "type": "array", "items": { "type": [ "string", "null" ] }, "description": "Regex-mode only: capture groups from the match, index i holding group i+1 (null for non-participating groups). Absent for plain text matches." } }, "additionalProperties": false, "required": [ "id", "handle", "matchKind", "address", "target", "snippet", "highlightRange", "blocks" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "$ref": "#/$defs/ResolvedHandle" }, "matchKind": { "const": "node" }, "address": { "$ref": "#/$defs/NodeAddress" }, "blocks": { "type": "array", "items": { "$ref": "#/$defs/MatchBlock" }, "maxItems": 0 } }, "additionalProperties": false, "required": [ "id", "handle", "matchKind", "address", "blocks" ] } ] } }, "page": { "$ref": "#/$defs/PageInfo" }, "meta": { "type": "object", "properties": { "effectiveResolved": { "type": "boolean" } }, "additionalProperties": false, "required": [ "effectiveResolved" ] } }, "additionalProperties": false, "required": [ "evaluatedRevision", "total", "items", "page", "meta" ] } ``` ### Pre-apply throws - `MATCH_NOT_FOUND` - `AMBIGUOUS_MATCH` - `INVALID_INPUT` - `INTERNAL_ERROR` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - None ### Related - [comments.create](/document-api/reference/comments/create): Anchor a comment to a text match target. - [replace](/document-api/reference/replace): Replace the exact matched range. - [delete](/document-api/reference/delete): Delete the exact matched range. - [Query content guide](/document-api/query-content): Learn targeting, cardinality, references, and revision safety. # Mutations operations Atomic mutation plan preview and execution. ## mutations.preview - Member path: `doc.mutations.preview(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a MutationsPreviewOutput with resolved targets and step details without applying changes. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "DeleteBehavior": { "enum": [ "selection", "exact" ] } }, "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "expectedRevision": { "type": "string", "description": "Document revision for optimistic concurrency. Mutation fails if document was modified since this revision." }, "atomic": { "const": true, "type": "boolean", "description": "Must be true. All steps execute as one atomic transaction." }, "changeMode": { "enum": [ "direct", "tracked" ], "description": "Required. Use 'direct' for immediate edits or 'tracked' for suggestions. Must always be provided." }, "steps": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "op": { "const": "text.rewrite", "type": "string" }, "where": { "oneOf": [ { "type": "object", "properties": { "by": { "const": "select", "type": "string" }, "select": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "text", "description": "Must be 'text' for text pattern search." }, "pattern": { "type": "string", "description": "Text to match. In regex mode, patterns are validated for syntax, maximum length, and safety before execution." }, "mode": { "enum": [ "contains", "regex" ], "description": "Match mode: 'contains' (literal substring, recommended for literal text) or 'regex' (validated regular expression)." }, "caseSensitive": { "type": "boolean", "description": "Case-sensitive matching. Default: false." }, "wholeWord": { "type": "boolean", "description": "Require word-boundary matches. Default: false." } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node", "description": "Must be 'node' for node type search." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ], "description": "Block type to match (paragraph, heading, table, listItem, etc.)." }, "kind": { "enum": [ "block", "inline" ], "description": "Filter: 'block' or 'inline'." } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress" }, "require": { "enum": [ "first", "exactlyOne", "all" ] } }, "additionalProperties": false, "required": [ "by", "select", "require" ] }, { "type": "object", "properties": { "by": { "const": "ref", "type": "string" }, "ref": { "type": "string" }, "within": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "by", "ref" ] }, { "type": "object", "properties": { "by": { "const": "target", "type": "string" }, "target": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "by", "target" ] }, { "type": "object", "properties": { "by": { "const": "block", "type": "string" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "by", "nodeType", "nodeId" ] } ] }, "args": { "type": "object", "properties": { "replacement": { "oneOf": [ { "type": "object", "properties": { "text": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, { "type": "object", "properties": { "blocks": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] } } }, "additionalProperties": false, "required": [ "blocks" ] } ] }, "style": { "type": "object", "properties": { "inline": { "type": "object", "properties": { "mode": { "enum": [ "preserve", "set", "clear", "merge" ], "type": "string" }, "requireUniform": { "type": "boolean" }, "onNonUniform": { "enum": [ "error", "useLeadingRun", "majority", "union" ] }, "setMarks": { "type": "object", "properties": { "bold": { "enum": [ "on", "off", "clear" ] }, "italic": { "enum": [ "on", "off", "clear" ] }, "underline": { "enum": [ "on", "off", "clear" ] }, "strike": { "enum": [ "on", "off", "clear" ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "mode" ] }, "paragraph": { "type": "object", "properties": { "mode": { "enum": [ "preserve", "set", "clear" ], "type": "string" } }, "additionalProperties": false, "required": [ "mode" ] } }, "additionalProperties": false, "required": [ "inline" ] } }, "additionalProperties": false, "required": [ "replacement" ] } }, "additionalProperties": false, "required": [ "id", "op", "where", "args" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "const": "text.insert", "type": "string" }, "where": { "oneOf": [ { "type": "object", "properties": { "by": { "const": "select", "type": "string" }, "select": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "text", "description": "Must be 'text' for text pattern search." }, "pattern": { "type": "string", "description": "Text to match. In regex mode, patterns are validated for syntax, maximum length, and safety before execution." }, "mode": { "enum": [ "contains", "regex" ], "description": "Match mode: 'contains' (literal substring, recommended for literal text) or 'regex' (validated regular expression)." }, "caseSensitive": { "type": "boolean", "description": "Case-sensitive matching. Default: false." }, "wholeWord": { "type": "boolean", "description": "Require word-boundary matches. Default: false." } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node", "description": "Must be 'node' for node type search." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ], "description": "Block type to match (paragraph, heading, table, listItem, etc.)." }, "kind": { "enum": [ "block", "inline" ], "description": "Filter: 'block' or 'inline'." } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress" }, "require": { "enum": [ "first", "exactlyOne" ] } }, "additionalProperties": false, "required": [ "by", "select", "require" ] }, { "type": "object", "properties": { "by": { "const": "ref", "type": "string" }, "ref": { "type": "string" }, "within": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "by", "ref" ] }, { "type": "object", "properties": { "by": { "const": "target", "type": "string" }, "target": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "by", "target" ] }, { "type": "object", "properties": { "by": { "const": "block", "type": "string" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "by", "nodeType", "nodeId" ] } ] }, "args": { "type": "object", "properties": { "position": { "enum": [ "before", "after" ] }, "content": { "type": "object", "properties": { "text": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "style": { "type": "object", "properties": { "inline": { "type": "object", "properties": { "mode": { "enum": [ "inherit", "set", "clear" ], "type": "string" }, "setMarks": { "type": "object", "properties": { "bold": { "enum": [ "on", "off", "clear" ] }, "italic": { "enum": [ "on", "off", "clear" ] }, "underline": { "enum": [ "on", "off", "clear" ] }, "strike": { "enum": [ "on", "off", "clear" ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "mode" ] } }, "additionalProperties": false, "required": [ "inline" ] } }, "additionalProperties": false, "required": [ "position", "content" ] } }, "additionalProperties": false, "required": [ "id", "op", "where", "args" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "const": "text.delete", "type": "string" }, "where": { "oneOf": [ { "type": "object", "properties": { "by": { "const": "select", "type": "string" }, "select": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "text", "description": "Must be 'text' for text pattern search." }, "pattern": { "type": "string", "description": "Text to match. In regex mode, patterns are validated for syntax, maximum length, and safety before execution." }, "mode": { "enum": [ "contains", "regex" ], "description": "Match mode: 'contains' (literal substring, recommended for literal text) or 'regex' (validated regular expression)." }, "caseSensitive": { "type": "boolean", "description": "Case-sensitive matching. Default: false." }, "wholeWord": { "type": "boolean", "description": "Require word-boundary matches. Default: false." } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node", "description": "Must be 'node' for node type search." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ], "description": "Block type to match (paragraph, heading, table, listItem, etc.)." }, "kind": { "enum": [ "block", "inline" ], "description": "Filter: 'block' or 'inline'." } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress" }, "require": { "enum": [ "first", "exactlyOne", "all" ] } }, "additionalProperties": false, "required": [ "by", "select", "require" ] }, { "type": "object", "properties": { "by": { "const": "ref", "type": "string" }, "ref": { "type": "string" }, "within": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "by", "ref" ] }, { "type": "object", "properties": { "by": { "const": "target", "type": "string" }, "target": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "by", "target" ] }, { "type": "object", "properties": { "by": { "const": "block", "type": "string" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "by", "nodeType", "nodeId" ] } ] }, "args": { "type": "object", "properties": { "behavior": { "$ref": "#/$defs/DeleteBehavior" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "id", "op", "where", "args" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "const": "format.apply", "type": "string" }, "where": { "oneOf": [ { "type": "object", "properties": { "by": { "const": "select", "type": "string" }, "select": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "text", "description": "Must be 'text' for text pattern search." }, "pattern": { "type": "string", "description": "Text to match. In regex mode, patterns are validated for syntax, maximum length, and safety before execution." }, "mode": { "enum": [ "contains", "regex" ], "description": "Match mode: 'contains' (literal substring, recommended for literal text) or 'regex' (validated regular expression)." }, "caseSensitive": { "type": "boolean", "description": "Case-sensitive matching. Default: false." }, "wholeWord": { "type": "boolean", "description": "Require word-boundary matches. Default: false." } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node", "description": "Must be 'node' for node type search." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ], "description": "Block type to match (paragraph, heading, table, listItem, etc.)." }, "kind": { "enum": [ "block", "inline" ], "description": "Filter: 'block' or 'inline'." } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress" }, "require": { "enum": [ "first", "exactlyOne", "all" ] } }, "additionalProperties": false, "required": [ "by", "select", "require" ] }, { "type": "object", "properties": { "by": { "const": "ref", "type": "string" }, "ref": { "type": "string" }, "within": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "by", "ref" ] }, { "type": "object", "properties": { "by": { "const": "target", "type": "string" }, "target": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "by", "target" ] }, { "type": "object", "properties": { "by": { "const": "block", "type": "string" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "by", "nodeType", "nodeId" ] } ] }, "args": { "type": "object", "properties": { "inline": { "type": "object", "properties": { "bold": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "italic": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "strike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "underline": { "oneOf": [ { "type": "boolean" }, { "type": "null" }, { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "themeColor": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 } ] }, "highlight": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "fontFamily": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "letterSpacing": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vertAlign": { "oneOf": [ { "enum": [ "superscript", "subscript", "baseline" ] }, { "type": "null" } ] }, "position": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "dstrike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "smallCaps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "caps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shading": { "oneOf": [ { "type": "object", "properties": { "fill": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "border": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "sz": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "space": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "outline": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shadow": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "emboss": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "imprint": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "charScale": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "kerning": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "webHidden": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "specVanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rtl": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "bCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "iCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "eastAsianLayout": { "oneOf": [ { "type": "object", "properties": { "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "combine": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "combineBrackets": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "vert": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "vertCompress": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "em": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fitText": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "snapToGrid": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "lang": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "bidi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "oMath": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rStyle": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "rFonts": { "oneOf": [ { "type": "object", "properties": { "ascii": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "asciiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsiaTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "csTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hint": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "fontSizeCs": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "ligatures": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numForm": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numSpacing": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "stylisticSets": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "val": { "type": "boolean" } }, "required": [ "id" ], "additionalProperties": false }, "minItems": 1 }, { "type": "null" } ] }, "contextualAlternates": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, "alignment": { "type": "string", "enum": [ "left", "center", "right", "justify" ], "description": "Set paragraph alignment on the target block(s). Can be combined with inline formatting in the same step." }, "scope": { "type": "string", "enum": [ "match", "block" ], "description": "When \"block\", inline formatting expands to cover the entire parent paragraph(s), not just the matched text. Use \"block\" after markdown inserts to format whole paragraphs with a short identifying pattern. Default: \"match\"." } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "required": [ "id", "op", "where", "args" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "const": "assert", "type": "string" }, "where": { "type": "object", "properties": { "by": { "const": "select", "type": "string" }, "select": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "text", "description": "Must be 'text' for text pattern search." }, "pattern": { "type": "string", "description": "Text to match. In regex mode, patterns are validated for syntax, maximum length, and safety before execution." }, "mode": { "enum": [ "contains", "regex" ], "description": "Match mode: 'contains' (literal substring, recommended for literal text) or 'regex' (validated regular expression)." }, "caseSensitive": { "type": "boolean", "description": "Case-sensitive matching. Default: false." }, "wholeWord": { "type": "boolean", "description": "Require word-boundary matches. Default: false." } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node", "description": "Must be 'node' for node type search." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ], "description": "Block type to match (paragraph, heading, table, listItem, etc.)." }, "kind": { "enum": [ "block", "inline" ], "description": "Filter: 'block' or 'inline'." } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "by", "select" ] }, "args": { "type": "object", "properties": { "expectCount": { "type": "number" } }, "additionalProperties": false, "required": [ "expectCount" ] } }, "additionalProperties": false, "required": [ "id", "op", "where", "args" ] } ] }, "description": "Ordered array of mutation steps. Each step needs 'op' (text.rewrite, text.insert, text.delete, format.apply, or assert) and a 'where' targeting clause." } }, "additionalProperties": false, "required": [ "atomic", "changeMode", "steps" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object" } }, "valid": { "type": "boolean" }, "failures": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": false, "required": [ "evaluatedRevision", "steps", "valid" ] } ``` ### Pre-apply throws - `REVISION_MISMATCH` - `MATCH_NOT_FOUND` - `AMBIGUOUS_MATCH` - `STYLE_CONFLICT` - `PRECONDITION_FAILED` - `INVALID_INPUT` - `CROSS_BLOCK_MATCH` - `SPAN_FRAGMENTED` - `TARGET_MOVED` - `PLAN_CONFLICT_OVERLAP` - `INVALID_STEP_COMBINATION` - `REVISION_CHANGED_SINCE_COMPILE` - `INVALID_INSERTION_CONTEXT` - `DOCUMENT_IDENTITY_CONFLICT` - `CAPABILITY_UNAVAILABLE` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - None ## mutations.apply - Member path: `doc.mutations.apply(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: no ### Expected result Returns a PlanReceipt with per-step results for the atomically applied mutation plan. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] }, "DeleteBehavior": { "enum": [ "selection", "exact" ] } }, "type": "object", "properties": { "in": { "$ref": "#/$defs/StoryLocator" }, "expectedRevision": { "type": "string", "description": "Document revision for optimistic concurrency. Mutation fails if document was modified since this revision." }, "atomic": { "const": true, "type": "boolean", "description": "Must be true. All steps execute as one atomic transaction." }, "changeMode": { "enum": [ "direct", "tracked" ], "description": "Required. Use 'direct' for immediate edits or 'tracked' for suggestions. Must always be provided." }, "steps": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "op": { "const": "text.rewrite", "type": "string" }, "where": { "oneOf": [ { "type": "object", "properties": { "by": { "const": "select", "type": "string" }, "select": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "text", "description": "Must be 'text' for text pattern search." }, "pattern": { "type": "string", "description": "Text to match. In regex mode, patterns are validated for syntax, maximum length, and safety before execution." }, "mode": { "enum": [ "contains", "regex" ], "description": "Match mode: 'contains' (literal substring, recommended for literal text) or 'regex' (validated regular expression)." }, "caseSensitive": { "type": "boolean", "description": "Case-sensitive matching. Default: false." }, "wholeWord": { "type": "boolean", "description": "Require word-boundary matches. Default: false." } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node", "description": "Must be 'node' for node type search." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ], "description": "Block type to match (paragraph, heading, table, listItem, etc.)." }, "kind": { "enum": [ "block", "inline" ], "description": "Filter: 'block' or 'inline'." } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress" }, "require": { "enum": [ "first", "exactlyOne", "all" ] } }, "additionalProperties": false, "required": [ "by", "select", "require" ] }, { "type": "object", "properties": { "by": { "const": "ref", "type": "string" }, "ref": { "type": "string" }, "within": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "by", "ref" ] }, { "type": "object", "properties": { "by": { "const": "target", "type": "string" }, "target": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "by", "target" ] }, { "type": "object", "properties": { "by": { "const": "block", "type": "string" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "by", "nodeType", "nodeId" ] } ] }, "args": { "type": "object", "properties": { "replacement": { "oneOf": [ { "type": "object", "properties": { "text": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, { "type": "object", "properties": { "blocks": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] } } }, "additionalProperties": false, "required": [ "blocks" ] } ] }, "style": { "type": "object", "properties": { "inline": { "type": "object", "properties": { "mode": { "enum": [ "preserve", "set", "clear", "merge" ], "type": "string" }, "requireUniform": { "type": "boolean" }, "onNonUniform": { "enum": [ "error", "useLeadingRun", "majority", "union" ] }, "setMarks": { "type": "object", "properties": { "bold": { "enum": [ "on", "off", "clear" ] }, "italic": { "enum": [ "on", "off", "clear" ] }, "underline": { "enum": [ "on", "off", "clear" ] }, "strike": { "enum": [ "on", "off", "clear" ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "mode" ] }, "paragraph": { "type": "object", "properties": { "mode": { "enum": [ "preserve", "set", "clear" ], "type": "string" } }, "additionalProperties": false, "required": [ "mode" ] } }, "additionalProperties": false, "required": [ "inline" ] } }, "additionalProperties": false, "required": [ "replacement" ] } }, "additionalProperties": false, "required": [ "id", "op", "where", "args" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "const": "text.insert", "type": "string" }, "where": { "oneOf": [ { "type": "object", "properties": { "by": { "const": "select", "type": "string" }, "select": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "text", "description": "Must be 'text' for text pattern search." }, "pattern": { "type": "string", "description": "Text to match. In regex mode, patterns are validated for syntax, maximum length, and safety before execution." }, "mode": { "enum": [ "contains", "regex" ], "description": "Match mode: 'contains' (literal substring, recommended for literal text) or 'regex' (validated regular expression)." }, "caseSensitive": { "type": "boolean", "description": "Case-sensitive matching. Default: false." }, "wholeWord": { "type": "boolean", "description": "Require word-boundary matches. Default: false." } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node", "description": "Must be 'node' for node type search." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ], "description": "Block type to match (paragraph, heading, table, listItem, etc.)." }, "kind": { "enum": [ "block", "inline" ], "description": "Filter: 'block' or 'inline'." } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress" }, "require": { "enum": [ "first", "exactlyOne" ] } }, "additionalProperties": false, "required": [ "by", "select", "require" ] }, { "type": "object", "properties": { "by": { "const": "ref", "type": "string" }, "ref": { "type": "string" }, "within": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "by", "ref" ] }, { "type": "object", "properties": { "by": { "const": "target", "type": "string" }, "target": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "by", "target" ] }, { "type": "object", "properties": { "by": { "const": "block", "type": "string" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "by", "nodeType", "nodeId" ] } ] }, "args": { "type": "object", "properties": { "position": { "enum": [ "before", "after" ] }, "content": { "type": "object", "properties": { "text": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "style": { "type": "object", "properties": { "inline": { "type": "object", "properties": { "mode": { "enum": [ "inherit", "set", "clear" ], "type": "string" }, "setMarks": { "type": "object", "properties": { "bold": { "enum": [ "on", "off", "clear" ] }, "italic": { "enum": [ "on", "off", "clear" ] }, "underline": { "enum": [ "on", "off", "clear" ] }, "strike": { "enum": [ "on", "off", "clear" ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "mode" ] } }, "additionalProperties": false, "required": [ "inline" ] } }, "additionalProperties": false, "required": [ "position", "content" ] } }, "additionalProperties": false, "required": [ "id", "op", "where", "args" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "const": "text.delete", "type": "string" }, "where": { "oneOf": [ { "type": "object", "properties": { "by": { "const": "select", "type": "string" }, "select": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "text", "description": "Must be 'text' for text pattern search." }, "pattern": { "type": "string", "description": "Text to match. In regex mode, patterns are validated for syntax, maximum length, and safety before execution." }, "mode": { "enum": [ "contains", "regex" ], "description": "Match mode: 'contains' (literal substring, recommended for literal text) or 'regex' (validated regular expression)." }, "caseSensitive": { "type": "boolean", "description": "Case-sensitive matching. Default: false." }, "wholeWord": { "type": "boolean", "description": "Require word-boundary matches. Default: false." } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node", "description": "Must be 'node' for node type search." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ], "description": "Block type to match (paragraph, heading, table, listItem, etc.)." }, "kind": { "enum": [ "block", "inline" ], "description": "Filter: 'block' or 'inline'." } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress" }, "require": { "enum": [ "first", "exactlyOne", "all" ] } }, "additionalProperties": false, "required": [ "by", "select", "require" ] }, { "type": "object", "properties": { "by": { "const": "ref", "type": "string" }, "ref": { "type": "string" }, "within": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "by", "ref" ] }, { "type": "object", "properties": { "by": { "const": "target", "type": "string" }, "target": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "by", "target" ] }, { "type": "object", "properties": { "by": { "const": "block", "type": "string" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "by", "nodeType", "nodeId" ] } ] }, "args": { "type": "object", "properties": { "behavior": { "$ref": "#/$defs/DeleteBehavior" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "id", "op", "where", "args" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "const": "format.apply", "type": "string" }, "where": { "oneOf": [ { "type": "object", "properties": { "by": { "const": "select", "type": "string" }, "select": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "text", "description": "Must be 'text' for text pattern search." }, "pattern": { "type": "string", "description": "Text to match. In regex mode, patterns are validated for syntax, maximum length, and safety before execution." }, "mode": { "enum": [ "contains", "regex" ], "description": "Match mode: 'contains' (literal substring, recommended for literal text) or 'regex' (validated regular expression)." }, "caseSensitive": { "type": "boolean", "description": "Case-sensitive matching. Default: false." }, "wholeWord": { "type": "boolean", "description": "Require word-boundary matches. Default: false." } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node", "description": "Must be 'node' for node type search." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ], "description": "Block type to match (paragraph, heading, table, listItem, etc.)." }, "kind": { "enum": [ "block", "inline" ], "description": "Filter: 'block' or 'inline'." } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress" }, "require": { "enum": [ "first", "exactlyOne", "all" ] } }, "additionalProperties": false, "required": [ "by", "select", "require" ] }, { "type": "object", "properties": { "by": { "const": "ref", "type": "string" }, "ref": { "type": "string" }, "within": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "by", "ref" ] }, { "type": "object", "properties": { "by": { "const": "target", "type": "string" }, "target": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false, "required": [ "by", "target" ] }, { "type": "object", "properties": { "by": { "const": "block", "type": "string" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "by", "nodeType", "nodeId" ] } ] }, "args": { "type": "object", "properties": { "inline": { "type": "object", "properties": { "bold": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "italic": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "strike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "underline": { "oneOf": [ { "type": "boolean" }, { "type": "null" }, { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "themeColor": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 } ] }, "highlight": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "fontFamily": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "letterSpacing": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vertAlign": { "oneOf": [ { "enum": [ "superscript", "subscript", "baseline" ] }, { "type": "null" } ] }, "position": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "dstrike": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "smallCaps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "caps": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shading": { "oneOf": [ { "type": "object", "properties": { "fill": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "border": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "sz": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "color": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "space": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "outline": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "shadow": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "emboss": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "imprint": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "charScale": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "kerning": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "vanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "webHidden": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "specVanish": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rtl": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "bCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "iCs": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "eastAsianLayout": { "oneOf": [ { "type": "object", "properties": { "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "combine": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "combineBrackets": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "vert": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "vertCompress": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "em": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "fitText": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "id": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "snapToGrid": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "lang": { "oneOf": [ { "type": "object", "properties": { "val": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "bidi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "oMath": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "rStyle": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "rFonts": { "oneOf": [ { "type": "object", "properties": { "ascii": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsi": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsia": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "cs": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "asciiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hAnsiTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "eastAsiaTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "csTheme": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hint": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, { "type": "null" } ] }, "fontSizeCs": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "ligatures": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numForm": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "numSpacing": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "stylisticSets": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "val": { "type": "boolean" } }, "required": [ "id" ], "additionalProperties": false }, "minItems": 1 }, { "type": "null" } ] }, "contextualAlternates": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false, "minProperties": 1 }, "alignment": { "type": "string", "enum": [ "left", "center", "right", "justify" ], "description": "Set paragraph alignment on the target block(s). Can be combined with inline formatting in the same step." }, "scope": { "type": "string", "enum": [ "match", "block" ], "description": "When \"block\", inline formatting expands to cover the entire parent paragraph(s), not just the matched text. Use \"block\" after markdown inserts to format whole paragraphs with a short identifying pattern. Default: \"match\"." } }, "additionalProperties": false, "minProperties": 1 } }, "additionalProperties": false, "required": [ "id", "op", "where", "args" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "const": "assert", "type": "string" }, "where": { "type": "object", "properties": { "by": { "const": "select", "type": "string" }, "select": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "text", "description": "Must be 'text' for text pattern search." }, "pattern": { "type": "string", "description": "Text to match. In regex mode, patterns are validated for syntax, maximum length, and safety before execution." }, "mode": { "enum": [ "contains", "regex" ], "description": "Match mode: 'contains' (literal substring, recommended for literal text) or 'regex' (validated regular expression)." }, "caseSensitive": { "type": "boolean", "description": "Case-sensitive matching. Default: false." }, "wholeWord": { "type": "boolean", "description": "Require word-boundary matches. Default: false." } }, "additionalProperties": false, "required": [ "type", "pattern" ] }, { "type": "object", "properties": { "type": { "const": "node", "description": "Must be 'node' for node type search." }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "endnoteRef", "crossRef", "indexEntry", "citation", "authorityEntry", "sequenceField", "tab", "lineBreak" ], "description": "Block type to match (paragraph, heading, table, listItem, etc.)." }, "kind": { "enum": [ "block", "inline" ], "description": "Filter: 'block' or 'inline'." } }, "additionalProperties": false, "required": [ "type" ] } ] }, "within": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "by", "select" ] }, "args": { "type": "object", "properties": { "expectCount": { "type": "number" } }, "additionalProperties": false, "required": [ "expectCount" ] } }, "additionalProperties": false, "required": [ "id", "op", "where", "args" ] } ] }, "description": "Ordered array of mutation steps. Each step needs 'op' (text.rewrite, text.insert, text.delete, format.apply, or assert) and a 'where' targeting clause." } }, "additionalProperties": false, "required": [ "atomic", "changeMode", "steps" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "const": true }, "revision": { "type": "object", "properties": { "before": { "type": "string" }, "after": { "type": "string" } }, "additionalProperties": false, "required": [ "before", "after" ] }, "steps": { "type": "array", "items": { "type": "object" } }, "trackedChanges": { "type": "array", "items": { "type": "object" } }, "timing": { "type": "object", "properties": { "totalMs": { "type": "number" } }, "additionalProperties": false, "required": [ "totalMs" ] } }, "additionalProperties": false, "required": [ "success", "revision", "steps", "timing" ] } ``` ### Pre-apply throws - `REVISION_MISMATCH` - `MATCH_NOT_FOUND` - `AMBIGUOUS_MATCH` - `STYLE_CONFLICT` - `PRECONDITION_FAILED` - `INVALID_INPUT` - `CROSS_BLOCK_MATCH` - `SPAN_FRAGMENTED` - `TARGET_MOVED` - `PLAN_CONFLICT_OVERLAP` - `INVALID_STEP_COMBINATION` - `REVISION_CHANGED_SINCE_COMPILE` - `INVALID_INSERTION_CONTEXT` - `DOCUMENT_IDENTITY_CONFLICT` - `CAPABILITY_UNAVAILABLE` - `DUPLICATE_ID` - `RAW_MODE_REQUIRED` - `PRESERVE_ONLY_VIOLATION` - `CAPABILITY_UNSUPPORTED` - `STORY_NOT_FOUND` - `STORY_MISMATCH` - `STORY_NOT_SUPPORTED` - `CROSS_STORY_PLAN` - `MATERIALIZATION_FAILED` ### Non-applied receipt codes - `INVALID_CONTEXT` ## plan.execute - Member path: `doc.plan.execute(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a PlanExecuteResult with per-entry receipts, projected captures, and the first hard failure if any. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "operationId": { "type": "string" }, "input": {}, "options": {}, "captureAs": { "type": "string" }, "expect": { "type": "object", "properties": { "success": { "type": "boolean" }, "failureCode": { "type": "string" }, "failureMessageIncludes": { "type": "string" }, "allowFailureMessageIncludes": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "operationId" ] } }, "captureReturns": { "oneOf": [ { "const": "*" }, { "type": "array", "items": { "type": "string" } } ] } }, "additionalProperties": false, "required": [ "entries" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "receipts": { "type": "array", "items": { "type": "object", "properties": { "entryIndex": { "type": "integer" }, "operationId": { "type": "string" }, "status": { "enum": [ "passed", "allowed-failure", "expected-failure" ] }, "captureAs": { "type": [ "string", "null" ] }, "error": { "type": "string" } }, "additionalProperties": false, "required": [ "entryIndex", "operationId", "status", "captureAs" ] } }, "captures": { "type": "object" }, "failure": { "type": "object", "properties": { "entryIndex": { "type": "integer" }, "operationId": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false, "required": [ "entryIndex", "operationId", "message" ] } }, "additionalProperties": false, "required": [ "receipts", "captures" ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Paragraph Formatting operations Paragraph-level direct formatting: alignment, indentation, spacing, borders, shading, and more. ## format.paragraph.resetDirectFormatting - Member path: `doc.format.paragraph.resetDirectFormatting(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if no direct formatting is present. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.setAlignment - Member path: `doc.format.paragraph.setAlignment(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if the alignment already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "alignment": { "enum": [ "left", "center", "right", "justify" ], "description": "Visual paragraph alignment. In RTL paragraphs, 'left' stores w:jc='right' and 'right' stores w:jc='left' so Word displays the requested side." } }, "additionalProperties": false, "required": [ "target", "alignment" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.clearAlignment - Member path: `doc.format.paragraph.clearAlignment(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if no direct alignment is set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.setIndentation - Member path: `doc.format.paragraph.setIndentation(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if indentation already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "left": { "type": "integer", "description": "Left indentation in twips (1440 = 1 inch)." }, "right": { "type": "integer", "description": "Right indentation in twips (1440 = 1 inch)." }, "firstLine": { "type": "integer", "minimum": 0, "description": "First line indent in twips. Cannot be combined with hanging." }, "hanging": { "type": "integer", "minimum": 0, "description": "Hanging indent in twips. Cannot be combined with firstLine." } }, "additionalProperties": false, "required": [ "target" ], "anyOf": [ { "required": [ "left" ] }, { "required": [ "right" ] }, { "required": [ "firstLine" ] }, { "required": [ "hanging" ] } ], "not": { "required": [ "firstLine", "hanging" ] } } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.clearIndentation - Member path: `doc.format.paragraph.clearIndentation(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if no direct indentation is set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.setSpacing - Member path: `doc.format.paragraph.setSpacing(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if spacing already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "before": { "type": "integer", "minimum": 0, "description": "Space before paragraph in twips (20 twips = 1pt)." }, "after": { "type": "integer", "minimum": 0, "description": "Space after paragraph in twips (20 twips = 1pt)." }, "line": { "type": "integer", "minimum": 1, "description": "Line spacing value. Meaning depends on lineRule. Must be provided together with lineRule." }, "lineRule": { "enum": [ "auto", "exact", "atLeast" ], "description": "Line spacing rule. Required when 'line' is set." } }, "additionalProperties": false, "required": [ "target" ], "anyOf": [ { "required": [ "before" ] }, { "required": [ "after" ] }, { "required": [ "line" ] }, { "required": [ "lineRule" ] } ], "if": { "required": [ "line" ] }, "then": { "required": [ "lineRule" ] } } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.clearSpacing - Member path: `doc.format.paragraph.clearSpacing(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if no direct spacing is set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.setKeepOptions - Member path: `doc.format.paragraph.setKeepOptions(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if all flags already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "keepNext": { "type": "boolean" }, "keepLines": { "type": "boolean" }, "widowControl": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target" ], "anyOf": [ { "required": [ "target", "keepNext" ] }, { "required": [ "target", "keepLines" ] }, { "required": [ "target", "widowControl" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.setOutlineLevel - Member path: `doc.format.paragraph.setOutlineLevel(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if outline level already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "outlineLevel": { "oneOf": [ { "type": "integer", "minimum": 0, "maximum": 9 }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "target", "outlineLevel" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.setFlowOptions - Member path: `doc.format.paragraph.setFlowOptions(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if all flags already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "contextualSpacing": { "type": "boolean" }, "pageBreakBefore": { "type": "boolean" }, "suppressAutoHyphens": { "type": "boolean" }, "autoSpaceDE": { "type": "boolean" }, "autoSpaceDN": { "type": "boolean" }, "adjustRightInd": { "type": "boolean" }, "snapToGrid": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target" ], "anyOf": [ { "required": [ "target", "contextualSpacing" ] }, { "required": [ "target", "pageBreakBefore" ] }, { "required": [ "target", "suppressAutoHyphens" ] }, { "required": [ "target", "autoSpaceDE" ] }, { "required": [ "target", "autoSpaceDN" ] }, { "required": [ "target", "adjustRightInd" ] }, { "required": [ "target", "snapToGrid" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.setTabStop - Member path: `doc.format.paragraph.setTabStop(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if an identical tab stop already exists. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "position": { "type": "integer" }, "alignment": { "enum": [ "left", "center", "right", "decimal", "bar", "clear" ] }, "leader": { "enum": [ "none", "dot", "hyphen", "underscore", "heavy", "middleDot" ] } }, "additionalProperties": false, "required": [ "target", "position", "alignment" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.clearTabStop - Member path: `doc.format.paragraph.clearTabStop(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if no tab stop exists at that position. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "position": { "type": "integer" } }, "additionalProperties": false, "required": [ "target", "position" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.clearAllTabStops - Member path: `doc.format.paragraph.clearAllTabStops(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if no tab stops exist. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.setBorder - Member path: `doc.format.paragraph.setBorder(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if the border already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "side": { "enum": [ "top", "bottom", "left", "right", "between", "bar" ] }, "style": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "size": { "type": "integer", "minimum": 0 }, "space": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "target", "side", "style" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.clearBorder - Member path: `doc.format.paragraph.clearBorder(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if the border is already absent. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "side": { "enum": [ "top", "bottom", "left", "right", "between", "bar", "all" ] } }, "additionalProperties": false, "required": [ "target", "side" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.setShading - Member path: `doc.format.paragraph.setShading(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if the shading already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "fill": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "pattern": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "target" ], "oneOf": [ { "required": [ "target", "fill" ] }, { "required": [ "target", "color" ] }, { "required": [ "target", "pattern" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.clearShading - Member path: `doc.format.paragraph.clearShading(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if no shading is set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.setMarkRunProps - Member path: `doc.format.paragraph.setMarkRunProps(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if the encoded mark run properties already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "markRunProps": { "type": "object", "properties": { "fontSizeCs": { "type": "number" }, "specVanish": { "type": "boolean" }, "fontSize": { "type": "number" }, "fonts": { "type": "object", "properties": { "ascii": { "type": "string", "minLength": 1 }, "hAnsi": { "type": "string", "minLength": 1 }, "eastAsia": { "type": "string", "minLength": 1 }, "cs": { "type": "string", "minLength": 1 }, "asciiTheme": { "type": "string", "minLength": 1 }, "hAnsiTheme": { "type": "string", "minLength": 1 }, "eastAsiaTheme": { "type": "string", "minLength": 1 }, "csTheme": { "type": "string", "minLength": 1 }, "hint": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "fontFamily": { "type": "string", "minLength": 1 }, "lang": { "type": "object", "properties": { "val": { "type": "string", "minLength": 1 }, "eastAsia": { "type": "string", "minLength": 1 }, "bidi": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "color": { "oneOf": [ { "type": "object", "properties": { "model": { "const": "rgb" }, "value": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "model", "value" ] }, { "type": "object", "properties": { "model": { "const": "theme" }, "theme": { "type": "string", "minLength": 1 }, "tint": { "type": "integer" }, "shade": { "type": "integer" } }, "additionalProperties": false, "required": [ "model", "theme" ] }, { "type": "object", "properties": { "model": { "const": "auto" } }, "additionalProperties": false, "required": [ "model" ] } ] }, "highlight": { "type": "string", "minLength": 1 }, "shading": { "type": "object", "properties": { "fill": { "oneOf": [ { "type": "object", "properties": { "model": { "const": "rgb" }, "value": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "model", "value" ] }, { "type": "object", "properties": { "model": { "const": "theme" }, "theme": { "type": "string", "minLength": 1 }, "tint": { "type": "integer" }, "shade": { "type": "integer" } }, "additionalProperties": false, "required": [ "model", "theme" ] }, { "type": "object", "properties": { "model": { "const": "auto" } }, "additionalProperties": false, "required": [ "model" ] } ] }, "color": { "oneOf": [ { "type": "object", "properties": { "model": { "const": "rgb" }, "value": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "model", "value" ] }, { "type": "object", "properties": { "model": { "const": "theme" }, "theme": { "type": "string", "minLength": 1 }, "tint": { "type": "integer" }, "shade": { "type": "integer" } }, "additionalProperties": false, "required": [ "model", "theme" ] }, { "type": "object", "properties": { "model": { "const": "auto" } }, "additionalProperties": false, "required": [ "model" ] } ] }, "pattern": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1 }, "cs": { "type": "boolean" }, "rtl": { "type": "boolean" }, "bold": { "type": "boolean" }, "boldCs": { "type": "boolean" }, "italic": { "type": "boolean" }, "italicCs": { "type": "boolean" }, "underline": { "type": "object", "properties": { "style": { "type": "string", "minLength": 1 }, "color": { "oneOf": [ { "type": "object", "properties": { "model": { "const": "rgb" }, "value": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "model", "value" ] }, { "type": "object", "properties": { "model": { "const": "theme" }, "theme": { "type": "string", "minLength": 1 }, "tint": { "type": "integer" }, "shade": { "type": "integer" } }, "additionalProperties": false, "required": [ "model", "theme" ] }, { "type": "object", "properties": { "model": { "const": "auto" } }, "additionalProperties": false, "required": [ "model" ] } ] } }, "additionalProperties": false, "minProperties": 1 }, "strikethrough": { "type": "boolean" }, "doubleStrikethrough": { "type": "boolean" }, "caps": { "type": "boolean" }, "smallCaps": { "type": "boolean" }, "outline": { "type": "boolean" }, "shadow": { "type": "boolean" }, "emboss": { "type": "boolean" }, "imprint": { "type": "boolean" }, "verticalAlign": { "enum": [ "baseline", "superscript", "subscript" ] }, "characterSpacing": { "type": "number" }, "characterScale": { "type": "number" }, "kern": { "type": "number" }, "baselineShift": { "type": "number" }, "fitTextWidth": { "type": "number" }, "vanish": { "type": "boolean" }, "webHidden": { "type": "boolean" }, "border": { "type": "object", "properties": { "style": { "type": "string", "minLength": 1 }, "width": { "type": "number" }, "space": { "type": "number" }, "color": { "oneOf": [ { "type": "object", "properties": { "model": { "const": "rgb" }, "value": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "model", "value" ] }, { "type": "object", "properties": { "model": { "const": "theme" }, "theme": { "type": "string", "minLength": 1 }, "tint": { "type": "integer" }, "shade": { "type": "integer" } }, "additionalProperties": false, "required": [ "model", "theme" ] }, { "type": "object", "properties": { "model": { "const": "auto" } }, "additionalProperties": false, "required": [ "model" ] } ] }, "frame": { "type": "boolean" }, "shadow": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 }, "textEffect": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "minProperties": 1, "description": "Paragraph-mark run properties (SDRunProps shape, e.g. fontSizeCs, specVanish)." } }, "additionalProperties": false, "required": [ "target", "markRunProps" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` - `CAPABILITY_UNAVAILABLE` ## format.paragraph.setDirection - Member path: `doc.format.paragraph.setDirection(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if the direction already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "direction": { "type": "string", "enum": [ "ltr", "rtl" ] }, "alignmentPolicy": { "type": "string", "enum": [ "preserve", "matchDirection" ] } }, "additionalProperties": false, "required": [ "target", "direction" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.clearDirection - Member path: `doc.format.paragraph.clearDirection(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if no direction is set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## format.paragraph.setNumbering - Member path: `doc.format.paragraph.setNumbering(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if the block already carries this numbering. On a successful apply, resolution.target reflects the post-mutation address (a numbered plain paragraph re-resolves to listItem; a heading stays a heading); a dryRun returns the input target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "numId": { "type": "integer", "minimum": 1 }, "level": { "type": "integer", "minimum": 0, "maximum": 8 } }, "additionalProperties": false, "required": [ "target", "numId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` # Paragraph Styles operations Paragraph style reference operations (set/clear w:pStyle). ## styles.paragraph.setStyle - Member path: `doc.styles.paragraph.setStyle(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if the style already matches. When the style changes, direct run formatting is cleared while character-style references are preserved. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "styleId": { "type": "string", "minLength": 1, "description": "Named paragraph style ID (e.g. 'Normal', 'Heading1', 'BodyText'). Use superdoc_search to find a nearby paragraph, then inspect its style to determine the correct styleId." }, "role": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "defaultParagraph" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "heading" }, "level": { "type": "integer", "minimum": 1, "maximum": 9 } }, "additionalProperties": false, "required": [ "kind", "level" ] }, { "type": "object", "properties": { "kind": { "const": "title" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "subtitle" } }, "additionalProperties": false, "required": [ "kind" ] } ], "description": "Semantic built-in style intent, resolved to the document authored style identity." } }, "additionalProperties": false, "required": [ "target" ], "anyOf": [ { "required": [ "styleId" ] }, { "required": [ "role" ] } ], "not": { "required": [ "styleId", "role" ] } } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_INPUT", "PRECONDITION_FAILED" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` - `INVALID_INPUT` - `PRECONDITION_FAILED` ## styles.paragraph.setStyleRef - Member path: `doc.styles.paragraph.setStyleRef(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if the style reference already matches. Unlike setStyle, existing run formatting is preserved. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "styleId": { "type": "string", "minLength": 1, "description": "Named paragraph style ID (e.g. 'Normal', 'Heading1'). Unlike setStyle, existing run formatting is preserved." } }, "additionalProperties": false, "required": [ "target", "styleId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_INPUT", "PRECONDITION_FAILED" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` - `INVALID_INPUT` - `PRECONDITION_FAILED` ## styles.paragraph.clearStyle - Member path: `doc.styles.paragraph.clearStyle(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ParagraphMutationResult; reports NO_OP if no style is set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ParagraphAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "HeadingAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "heading" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "ListItemAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "listItem" }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/TrackedChangeAddress" } } }, "additionalProperties": false, "required": [ "success", "target", "resolution" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] }, "resolution": { "type": "object", "properties": { "target": { "oneOf": [ { "$ref": "#/$defs/ParagraphAddress" }, { "$ref": "#/$defs/HeadingAddress" }, { "$ref": "#/$defs/ListItemAddress" } ] } }, "additionalProperties": false, "required": [ "target" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` # Templates operations Apply detected DOCX template/substrate (styles, numbering, settings, theme, font table, web settings, custom XML) from a source package onto the current document while preserving body content. ## templates.apply - Member path: `await doc.templates.apply(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TemplatesApplyReceipt with detected/applied/skipped scopes, unsupported items, changed parts, id mappings, and warnings. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "source": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "path" }, "path": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "path" ] }, { "type": "object", "properties": { "kind": { "const": "base64" }, "data": { "type": "string" }, "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "data" ] } ] }, "bodyPolicy": { "const": "preserve" } }, "additionalProperties": false, "required": [ "source" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "changed": { "type": "boolean" }, "dryRun": { "type": "boolean" }, "bodyPolicy": { "const": "preserve" }, "source": { "type": "object", "properties": { "kind": { "enum": [ "path", "base64" ] }, "fingerprint": { "type": "string" }, "partCount": { "type": "integer" } }, "additionalProperties": false, "required": [ "kind", "fingerprint", "partCount" ] }, "detectedScopes": { "type": "array", "items": { "type": "object", "properties": { "scope": { "enum": [ "styles", "numbering", "settings", "theme", "fontTable", "webSettings", "headersFooters", "sectionDefaults" ] }, "part": { "type": "string" }, "detail": { "type": "string" } }, "additionalProperties": false, "required": [ "scope", "part" ] } }, "appliedScopes": { "type": "array", "items": { "type": "object", "properties": { "scope": { "enum": [ "styles", "numbering", "settings", "theme", "fontTable", "webSettings", "headersFooters", "sectionDefaults" ] }, "part": { "type": "string" }, "detail": { "type": "string" } }, "additionalProperties": false, "required": [ "scope", "part" ] } }, "skippedScopes": { "type": "array", "items": { "type": "object", "properties": { "scope": { "type": "string" }, "part": { "type": "string" }, "reason": { "enum": [ "NOT_PRESENT_IN_SOURCE", "OUT_OF_SCOPE", "NO_CHANGE", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" } }, "additionalProperties": false, "required": [ "scope", "reason", "message" ] } }, "unsupportedItems": { "type": "array", "items": { "type": "object", "properties": { "part": { "type": "string" }, "category": { "type": "string" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "part", "category", "reason" ] } }, "changedParts": { "type": "array", "items": { "type": "object", "properties": { "part": { "type": "string" }, "scope": { "enum": [ "styles", "numbering", "settings", "theme", "fontTable", "webSettings", "headersFooters", "sectionDefaults", "package" ] }, "change": { "enum": [ "created", "replaced", "merged", "imported" ] } }, "additionalProperties": false, "required": [ "part", "scope", "change" ] } }, "idMappings": { "type": "object", "properties": { "styles": { "type": "array", "items": { "type": "object", "properties": { "kind": { "enum": [ "style", "numbering", "relationship" ] }, "from": { "type": "string" }, "to": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "from", "to" ] } }, "numbering": { "type": "array", "items": { "type": "object", "properties": { "kind": { "enum": [ "style", "numbering", "relationship" ] }, "from": { "type": "string" }, "to": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "from", "to" ] } }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "kind": { "enum": [ "style", "numbering", "relationship" ] }, "from": { "type": "string" }, "to": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "from", "to" ] } } }, "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "message" ] } } }, "additionalProperties": false, "required": [ "success", "changed", "dryRun", "bodyPolicy", "source", "detectedScopes", "appliedScopes", "skippedScopes", "unsupportedItems", "changedParts", "idMappings", "warnings" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "UNSUPPORTED_SOURCE", "INVALID_PACKAGE", "CAPABILITY_UNAVAILABLE", "UNSUPPORTED_TEMPLATE_CONTENT" ] }, "message": { "type": "string" } }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `REVISION_MISMATCH` ### Non-applied receipt codes - `UNSUPPORTED_SOURCE` - `INVALID_PACKAGE` - `CAPABILITY_UNAVAILABLE` - `UNSUPPORTED_TEMPLATE_CONTENT` # Tables operations Table structure, layout, styling, and cell operations. ## tables.convertFromText - Member path: `doc.tables.convertFromText(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt confirming text was converted into a table. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/BlockNodeAddress" }, "nodeId": { "type": "string" }, "delimiter": { "oneOf": [ { "enum": [ "tab", "comma", "paragraph" ] }, { "type": "object", "properties": { "custom": { "type": "string", "minLength": 1, "maxLength": 1 } }, "additionalProperties": false, "required": [ "custom" ] } ] }, "columns": { "type": "integer", "minimum": 1 }, "inferColumns": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` ## tables.delete - Member path: `doc.tables.delete(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the table was already removed. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.clearContents - Member path: `doc.tables.clearContents(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the target cells are already empty. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.move - Member path: `doc.tables.move(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the table is already at the target position. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "destination": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] } ] } }, "additionalProperties": false, "required": [ "destination" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.split - Member path: `doc.tables.split(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt confirming the table was split at the target row. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "rowIndex": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "rowIndex" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` ## tables.convertToText - Member path: `doc.tables.convertToText(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the table has no content to convert. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "delimiter": { "enum": [ "tab", "comma", "paragraph" ] } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.setLayout - Member path: `doc.tables.setLayout(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the table already uses the requested layout mode. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "preferredWidth": { "type": "number" }, "preferredWidthType": { "enum": [ "dxa", "auto", "pct" ] }, "alignment": { "enum": [ "left", "center", "right" ] }, "leftIndentPt": { "type": "number" }, "autoFitMode": { "enum": [ "fixedWidth", "fitContents", "fitWindow" ] }, "tableDirection": { "enum": [ "ltr", "rtl" ] } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.insertRow - Member path: `doc.tables.insertRow(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt confirming a row was inserted. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableRowAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableRow" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableRowAddress" }, "position": { "enum": [ "above", "below" ] }, "count": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "target", "position" ] }, { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "rowIndex": { "type": "integer", "minimum": 0 }, "position": { "enum": [ "above", "below" ] }, "count": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "target", "rowIndex", "position" ] }, { "type": "object", "properties": { "nodeId": { "type": "string" }, "rowIndex": { "type": "integer", "minimum": 0 }, "position": { "enum": [ "above", "below" ] }, "count": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "nodeId", "rowIndex", "position" ] }, { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "count": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ], "not": { "anyOf": [ { "required": [ "rowIndex" ] }, { "required": [ "position" ] } ] } } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` ## tables.deleteRow - Member path: `doc.tables.deleteRow(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the target row does not exist. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableRowAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableRow" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableRowAddress" } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "rowIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "target", "rowIndex" ] }, { "type": "object", "properties": { "nodeId": { "type": "string" }, "rowIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "nodeId", "rowIndex" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.moveRow - Member path: `doc.tables.moveRow(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the row is already at the requested position. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableRowAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableRow" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableRowAddress" }, "destination": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "first" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "last" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "rowIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "kind", "rowIndex" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "rowIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "kind", "rowIndex" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/TableRowAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/TableRowAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] } ] } }, "additionalProperties": false, "required": [ "target", "destination" ] }, { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "rowIndex": { "type": "integer", "minimum": 0 }, "destination": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "first" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "last" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "rowIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "kind", "rowIndex" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "rowIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "kind", "rowIndex" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/TableRowAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/TableRowAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] } ] } }, "additionalProperties": false, "required": [ "target", "rowIndex", "destination" ] }, { "type": "object", "properties": { "nodeId": { "type": "string" }, "rowIndex": { "type": "integer", "minimum": 0 }, "destination": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "first" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "last" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "rowIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "kind", "rowIndex" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "rowIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "kind", "rowIndex" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/TableRowAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/TableRowAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] } ] } }, "additionalProperties": false, "required": [ "nodeId", "rowIndex", "destination" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` - `CAPABILITY_UNAVAILABLE` ## tables.setRowHeight - Member path: `doc.tables.setRowHeight(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the row height already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableRowAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableRow" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableRowAddress" }, "heightPt": { "type": "number", "exclusiveMinimum": 0 }, "rule": { "enum": [ "atLeast", "exact", "auto" ] } }, "additionalProperties": false, "required": [ "target", "heightPt" ] }, { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "rowIndex": { "type": "integer", "minimum": 0 }, "heightPt": { "type": "number", "exclusiveMinimum": 0 }, "rule": { "enum": [ "atLeast", "exact", "auto" ] } }, "additionalProperties": false, "required": [ "target", "rowIndex", "heightPt" ] }, { "type": "object", "properties": { "nodeId": { "type": "string" }, "rowIndex": { "type": "integer", "minimum": 0 }, "heightPt": { "type": "number", "exclusiveMinimum": 0 }, "rule": { "enum": [ "atLeast", "exact", "auto" ] } }, "additionalProperties": false, "required": [ "nodeId", "rowIndex", "heightPt" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.distributeRows - Member path: `doc.tables.distributeRows(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if row heights are already equal. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.setRowOptions - Member path: `doc.tables.setRowOptions(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if row options already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableRowAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableRow" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableRowAddress" }, "allowBreakAcrossPages": { "type": "boolean" }, "repeatHeader": { "type": "boolean" }, "gridBefore": { "type": "integer", "minimum": 0 }, "gridAfter": { "type": "integer", "minimum": 0 }, "wBefore": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 0 }, "type": { "enum": [ "auto", "dxa", "nil", "pct" ] } }, "additionalProperties": false, "required": [ "value", "type" ] }, "wAfter": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 0 }, "type": { "enum": [ "auto", "dxa", "nil", "pct" ] } }, "additionalProperties": false, "required": [ "value", "type" ] } }, "additionalProperties": false, "required": [ "target" ] }, { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "rowIndex": { "type": "integer", "minimum": 0 }, "allowBreakAcrossPages": { "type": "boolean" }, "repeatHeader": { "type": "boolean" }, "gridBefore": { "type": "integer", "minimum": 0 }, "gridAfter": { "type": "integer", "minimum": 0 }, "wBefore": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 0 }, "type": { "enum": [ "auto", "dxa", "nil", "pct" ] } }, "additionalProperties": false, "required": [ "value", "type" ] }, "wAfter": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 0 }, "type": { "enum": [ "auto", "dxa", "nil", "pct" ] } }, "additionalProperties": false, "required": [ "value", "type" ] } }, "additionalProperties": false, "required": [ "target", "rowIndex" ] }, { "type": "object", "properties": { "nodeId": { "type": "string" }, "rowIndex": { "type": "integer", "minimum": 0 }, "allowBreakAcrossPages": { "type": "boolean" }, "repeatHeader": { "type": "boolean" }, "gridBefore": { "type": "integer", "minimum": 0 }, "gridAfter": { "type": "integer", "minimum": 0 }, "wBefore": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 0 }, "type": { "enum": [ "auto", "dxa", "nil", "pct" ] } }, "additionalProperties": false, "required": [ "value", "type" ] }, "wAfter": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 0 }, "type": { "enum": [ "auto", "dxa", "nil", "pct" ] } }, "additionalProperties": false, "required": [ "value", "type" ] } }, "additionalProperties": false, "required": [ "nodeId", "rowIndex" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.insertColumn - Member path: `doc.tables.insertColumn(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt confirming a column was inserted. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "columnIndex": { "type": "integer", "minimum": 0 }, "position": { "enum": [ "left", "right", "first", "last" ] }, "count": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "position" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` ## tables.deleteColumn - Member path: `doc.tables.deleteColumn(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the target column does not exist. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "columnIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "columnIndex" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.setColumnWidth - Member path: `doc.tables.setColumnWidth(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the column width already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "columnIndex": { "type": "integer", "minimum": 0 }, "widthPt": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "columnIndex", "widthPt" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.distributeColumns - Member path: `doc.tables.distributeColumns(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if column widths are already equal. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "columnRange": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0 }, "end": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "start", "end" ] } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.insertCell - Member path: `doc.tables.insertCell(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt confirming a cell was inserted. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableCell" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableCellAddress" }, "nodeId": { "type": "string" }, "mode": { "enum": [ "shiftRight", "shiftDown" ] } }, "additionalProperties": false, "required": [ "mode" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` ## tables.deleteCell - Member path: `doc.tables.deleteCell(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the target cell does not exist. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableCell" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableCellAddress" }, "nodeId": { "type": "string" }, "mode": { "enum": [ "shiftLeft", "shiftUp" ] } }, "additionalProperties": false, "required": [ "mode" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.mergeCells - Member path: `doc.tables.mergeCells(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the cells are already merged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "start": { "type": "object", "properties": { "rowIndex": { "type": "integer", "minimum": 0 }, "columnIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "rowIndex", "columnIndex" ] }, "end": { "type": "object", "properties": { "rowIndex": { "type": "integer", "minimum": 0 }, "columnIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "rowIndex", "columnIndex" ] } }, "additionalProperties": false, "required": [ "start", "end" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_CONTEXT` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` - `INVALID_CONTEXT` ## tables.unmergeCells - Member path: `doc.tables.unmergeCells(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the cell is not merged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableCell" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableCellAddress" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] }, { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "rowIndex": { "type": "integer", "minimum": 0 }, "columnIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "target", "rowIndex", "columnIndex" ] }, { "type": "object", "properties": { "nodeId": { "type": "string" }, "rowIndex": { "type": "integer", "minimum": 0 }, "columnIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "nodeId", "rowIndex", "columnIndex" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_CONTEXT` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` - `INVALID_CONTEXT` ## tables.splitCell - Member path: `doc.tables.splitCell(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt confirming the cell was split. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableCell" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableCellAddress" }, "nodeId": { "type": "string" }, "rows": { "type": "integer", "minimum": 1 }, "columns": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "rows", "columns" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_CONTEXT` ### Non-applied receipt codes - `INVALID_TARGET` - `INVALID_CONTEXT` ## tables.setCellProperties - Member path: `doc.tables.setCellProperties(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if cell properties already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableCell" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableCellAddress" }, "nodeId": { "type": "string" }, "preferredWidthPt": { "type": "number" }, "preferredWidthType": { "enum": [ "auto", "dxa", "pct" ] }, "verticalAlign": { "enum": [ "top", "center", "bottom" ] }, "wrapText": { "type": "boolean" }, "fitText": { "type": "boolean" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.setCellText - Member path: `doc.tables.setCellText(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the cell already contains exactly this text. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableCell" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableCellAddress" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "text" ] }, { "type": "object", "properties": { "nodeId": { "type": "string" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeId", "text" ] }, { "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "rowIndex": { "type": "integer", "minimum": 0 }, "columnIndex": { "type": "integer", "minimum": 0 }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "rowIndex", "columnIndex", "text" ] }, { "type": "object", "properties": { "nodeId": { "type": "string" }, "rowIndex": { "type": "integer", "minimum": 0 }, "columnIndex": { "type": "integer", "minimum": 0 }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeId", "rowIndex", "columnIndex", "text" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.sort - Member path: `doc.tables.sort(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt confirming rows were reordered. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "keys": { "type": "array", "items": { "type": "object", "properties": { "columnIndex": { "type": "integer", "minimum": 0 }, "direction": { "enum": [ "ascending", "descending" ] }, "type": { "enum": [ "text", "number", "date" ] } }, "additionalProperties": false, "required": [ "columnIndex", "direction", "type" ] }, "minItems": 1, "description": "At least one sort key is required." } }, "additionalProperties": false, "required": [ "keys" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` ## tables.setAltText - Member path: `doc.tables.setAltText(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if alt text already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.setStyle - Member path: `doc.tables.setStyle(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the table already uses the requested style or has no style to clear. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "styleId": { "type": "string" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.clearStyle - Member path: `doc.tables.clearStyle(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if no table style is applied. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.setStyleOption - Member path: `doc.tables.setStyleOption(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the style option already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "flag": { "enum": [ "headerRow", "lastRow", "totalRow", "firstColumn", "lastColumn", "bandedRows", "bandedColumns" ] }, "enabled": { "type": "boolean" } }, "additionalProperties": false, "required": [ "flag", "enabled" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.setBorder - Member path: `doc.tables.setBorder(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if border properties already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableOrCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "table", "tableCell" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableOrCellAddress" }, "nodeId": { "type": "string" }, "edge": { "enum": [ "top", "bottom", "left", "right", "insideH", "insideV", "diagonalDown", "diagonalUp" ] }, "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "edge", "lineStyle", "lineWeightPt", "color" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.clearBorder - Member path: `doc.tables.clearBorder(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if no borders are set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableOrCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "table", "tableCell" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableOrCellAddress" }, "nodeId": { "type": "string" }, "edge": { "enum": [ "top", "bottom", "left", "right", "insideH", "insideV", "diagonalDown", "diagonalUp" ] } }, "additionalProperties": false, "required": [ "edge" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.applyBorderPreset - Member path: `doc.tables.applyBorderPreset(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the preset is already applied. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "preset": { "enum": [ "box", "all", "none", "grid", "custom" ] } }, "additionalProperties": false, "required": [ "preset" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.setShading - Member path: `doc.tables.setShading(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if shading already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableOrCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "table", "tableCell" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableOrCellAddress" }, "nodeId": { "type": "string" }, "color": { "oneOf": [ { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "color" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.clearShading - Member path: `doc.tables.clearShading(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if no shading is set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableOrCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "table", "tableCell" ] }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableOrCellAddress" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.setTablePadding - Member path: `doc.tables.setTablePadding(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if table padding already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "topPt": { "type": "number", "minimum": 0 }, "rightPt": { "type": "number", "minimum": 0 }, "bottomPt": { "type": "number", "minimum": 0 }, "leftPt": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "topPt", "rightPt", "bottomPt", "leftPt" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.setCellPadding - Member path: `doc.tables.setCellPadding(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if cell padding already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableCell" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableCellAddress" }, "nodeId": { "type": "string" }, "topPt": { "type": "number", "minimum": 0 }, "rightPt": { "type": "number", "minimum": 0 }, "bottomPt": { "type": "number", "minimum": 0 }, "leftPt": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ], "anyOf": [ { "required": [ "topPt" ] }, { "required": [ "rightPt" ] }, { "required": [ "bottomPt" ] }, { "required": [ "leftPt" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.setCellSpacing - Member path: `doc.tables.setCellSpacing(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if cell spacing already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "spacingPt": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "spacingPt" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.clearCellSpacing - Member path: `doc.tables.clearCellSpacing(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if no custom cell spacing is set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## tables.applyStyle - Member path: `doc.tables.applyStyle(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the style and all provided options already match. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/BlockNodeAddress" }, "nodeId": { "type": "string" }, "styleId": { "type": "string" }, "styleOptions": { "type": "object", "properties": { "headerRow": { "type": "boolean" }, "lastRow": { "type": "boolean" }, "totalRow": { "type": "boolean" }, "firstColumn": { "type": "boolean" }, "lastColumn": { "type": "boolean" }, "bandedRows": { "type": "boolean" }, "bandedColumns": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `INVALID_INPUT` ## tables.setBorders - Member path: `doc.tables.setBorders(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt. Does not perform NO_OP detection. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "target": { "$ref": "#/$defs/BlockNodeAddress" }, "nodeId": { "type": "string" }, "mode": { "const": "applyTo" }, "applyTo": { "enum": [ "all", "outside", "inside", "top", "bottom", "left", "right", "insideH", "insideV" ] }, "border": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "mode", "applyTo", "border" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] }, { "type": "object", "properties": { "target": { "$ref": "#/$defs/BlockNodeAddress" }, "nodeId": { "type": "string" }, "mode": { "const": "edges" }, "edges": { "type": "object", "properties": { "top": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] }, "bottom": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] }, "left": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] }, "right": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] }, "insideH": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] }, "insideV": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "mode", "edges" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `INVALID_INPUT` ## tables.setTableOptions - Member path: `doc.tables.setTableOptions(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt; reports NO_OP if the provided values already match current direct formatting. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/BlockNodeAddress" }, "nodeId": { "type": "string" }, "defaultCellMargins": { "type": "object", "properties": { "topPt": { "type": "number", "minimum": 0 }, "rightPt": { "type": "number", "minimum": 0 }, "bottomPt": { "type": "number", "minimum": 0 }, "leftPt": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "topPt", "rightPt", "bottomPt", "leftPt" ] }, "cellSpacingPt": { "oneOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `INVALID_INPUT` ## tables.applyPreset - Member path: `doc.tables.applyPreset(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TableMutationResult receipt. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "preset": { "enum": [ "grid", "minimal", "striped", "accent" ] }, "accentColor": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "preset" ], "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "table": { "$ref": "#/$defs/TableAddress" }, "trackedChangeRefs": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` ## tables.get - Member path: `doc.tables.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a TablesGetOutput with the table row count, column count, and structural metadata. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "nodeId": { "type": "string" }, "address": { "$ref": "#/$defs/TableAddress" }, "rows": { "type": "integer", "minimum": 0 }, "columns": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "nodeId", "address", "rows", "columns" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` ### Non-applied receipt codes - None ## tables.getCells - Member path: `doc.tables.getCells(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a TablesGetCellsOutput with cell information for the requested rows and columns. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" }, "rowIndex": { "type": "integer", "minimum": 0 }, "columnIndex": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TableCellAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableCell" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "nodeId": { "type": "string" }, "address": { "$ref": "#/$defs/TableAddress" }, "cells": { "type": "array", "items": { "type": "object", "properties": { "nodeId": { "type": "string" }, "address": { "$ref": "#/$defs/TableCellAddress" }, "rowIndex": { "type": "integer", "minimum": 0 }, "columnIndex": { "type": "integer", "minimum": 0 }, "colspan": { "type": "integer", "minimum": 1 }, "rowspan": { "type": "integer", "minimum": 1 } }, "additionalProperties": false, "required": [ "nodeId", "address", "rowIndex", "columnIndex", "colspan", "rowspan" ] } } }, "additionalProperties": false, "required": [ "nodeId", "address", "cells" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` ### Non-applied receipt codes - None ## tables.getProperties - Member path: `doc.tables.getProperties(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a TablesGetPropertiesOutput with direct table layout and style state, including style options, borders, default cell margins, and cell spacing when explicitly set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TableAddress" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "oneOf": [ { "required": [ "target" ] }, { "required": [ "nodeId" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TableAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "table" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "nodeId": { "type": "string" }, "address": { "$ref": "#/$defs/TableAddress" }, "styleId": { "type": "string" }, "alignment": { "enum": [ "left", "center", "right" ] }, "direction": { "enum": [ "ltr", "rtl" ] }, "preferredWidth": { "type": "number" }, "preferredWidthType": { "enum": [ "dxa", "auto", "pct" ] }, "autoFitMode": { "enum": [ "fixedWidth", "fitContents", "fitWindow" ] }, "styleOptions": { "type": "object", "properties": { "headerRow": { "type": "boolean" }, "lastRow": { "type": "boolean" }, "firstColumn": { "type": "boolean" }, "lastColumn": { "type": "boolean" }, "bandedRows": { "type": "boolean" }, "bandedColumns": { "type": "boolean" } }, "additionalProperties": false }, "borders": { "type": "object", "properties": { "top": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] }, "bottom": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] }, "left": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] }, "right": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] }, "insideH": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] }, "insideV": { "oneOf": [ { "type": "object", "properties": { "lineStyle": { "type": "string" }, "lineWeightPt": { "type": "number", "exclusiveMinimum": 0 }, "color": { "type": "string", "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$" } }, "additionalProperties": false, "required": [ "lineStyle", "lineWeightPt", "color" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "defaultCellMargins": { "type": "object", "properties": { "topPt": { "type": "number" }, "rightPt": { "type": "number" }, "bottomPt": { "type": "number" }, "leftPt": { "type": "number" } }, "additionalProperties": false }, "cellSpacingPt": { "type": "number" } }, "additionalProperties": false, "required": [ "nodeId", "address" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` ### Non-applied receipt codes - None ## tables.getStyles - Member path: `doc.tables.getStyles(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a TablesGetStylesOutput with the style catalog, explicit default, and effective default. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "explicitDefaultStyleId": { "type": [ "string", "null" ] }, "effectiveDefaultStyleId": { "type": [ "string", "null" ] }, "effectiveDefaultSource": { "type": "string" }, "styles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "basedOn": { "type": [ "string", "null" ] }, "isDefault": { "type": "boolean" }, "isCustom": { "type": "boolean" }, "uiPriority": { "type": [ "integer", "null" ] }, "hidden": { "type": "boolean" }, "quickFormat": { "type": "boolean" }, "conditionalRegions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "id", "name", "basedOn", "isDefault", "isCustom", "uiPriority", "hidden", "quickFormat", "conditionalRegions" ] } } }, "additionalProperties": false, "required": [ "explicitDefaultStyleId", "effectiveDefaultStyleId", "effectiveDefaultSource", "styles" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - None ## tables.setDefaultStyle - Member path: `doc.tables.setDefaultStyle(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a DocumentMutationResult; reports NO_OP if the default already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "styleId": { "type": "string" } }, "additionalProperties": false, "required": [ "styleId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` - `INVALID_INPUT` ## tables.clearDefaultStyle - Member path: `doc.tables.clearDefaultStyle(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a DocumentMutationResult; reports NO_OP if no default is set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` # History operations Undo/redo history state and navigation. ## history.get - Member path: `doc.history.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a HistoryState object with undoDepth, redoDepth, canUndo, canRedo, and a list of history-unsafe operations. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "undoDepth": { "type": "integer", "minimum": 0 }, "redoDepth": { "type": "integer", "minimum": 0 }, "canUndo": { "type": "boolean" }, "canRedo": { "type": "boolean" }, "historyUnsafeOperations": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "undoDepth", "redoDepth", "canUndo", "canRedo", "historyUnsafeOperations" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - None ## history.undo - Member path: `doc.history.undo(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a HistoryActionResult with noop flag, revision before/after, optional noop reason, and optional ref-effect fields such as inserted, removed, invalidatedRefs, remappedRefs, and affectedStories. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "type": "object", "properties": { "noop": { "type": "boolean" }, "reason": { "enum": [ "EMPTY_UNDO_STACK", "EMPTY_REDO_STACK", "NO_EFFECT", "no-undo-available", "no-redo-available", "history-entry-missing", "apply-rejected" ] }, "revision": { "type": "object", "properties": { "before": { "type": "string" }, "after": { "type": "string" } }, "additionalProperties": false, "required": [ "before", "after" ] }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "invalidatedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRef" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "status": { "enum": [ "applied", "noop", "rejected", "partial", "repaired" ] }, "diagnosticCode": { "type": "string" }, "collaboration": { "type": "object", "properties": { "mode": { "enum": [ "session-local", "single-shard", "journaled-multi-shard" ] }, "undoGroupId": { "type": "string" }, "opId": { "type": "string" }, "affectedShards": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "mode" ] } }, "additionalProperties": false, "required": [ "noop", "revision" ] } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## history.redo - Member path: `doc.history.redo(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a HistoryActionResult with noop flag, revision before/after, optional noop reason, and optional ref-effect fields such as inserted, removed, invalidatedRefs, remappedRefs, and affectedStories. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "type": "object", "properties": { "noop": { "type": "boolean" }, "reason": { "enum": [ "EMPTY_UNDO_STACK", "EMPTY_REDO_STACK", "NO_EFFECT", "no-undo-available", "no-redo-available", "history-entry-missing", "apply-rejected" ] }, "revision": { "type": "object", "properties": { "before": { "type": "string" }, "after": { "type": "string" } }, "additionalProperties": false, "required": [ "before", "after" ] }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "invalidatedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRef" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "status": { "enum": [ "applied", "noop", "rejected", "partial", "repaired" ] }, "diagnosticCode": { "type": "string" }, "collaboration": { "type": "object", "properties": { "mode": { "enum": [ "session-local", "single-shard", "journaled-multi-shard" ] }, "undoGroupId": { "type": "string" }, "opId": { "type": "string" }, "affectedShards": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "mode" ] } }, "additionalProperties": false, "required": [ "noop", "revision" ] } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Table of Contents operations Table of contents lifecycle and configuration. ## toc.list - Member path: `doc.toc.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a TocListResult with an array of TOC discovery items and pagination metadata. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ResolvedHandle": { "type": "object", "properties": { "ref": { "type": "string" }, "refStability": { "enum": [ "stable", "ephemeral" ] }, "targetKind": { "$ref": "#/$defs/TargetKind" } }, "additionalProperties": false, "required": [ "ref", "refStability", "targetKind" ] }, "TargetKind": { "anyOf": [ { "enum": [ "text", "node", "list", "comment", "trackedChange", "table", "tableCell", "tableOfContents", "section", "sdt", "field" ] }, { "type": "string", "pattern": "^ext:.+$" } ] }, "PageInfo": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "returned": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "limit", "offset", "returned" ] } }, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "$ref": "#/$defs/ResolvedHandle" }, "address": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfContents" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "instruction": { "type": "string" }, "sourceConfig": { "type": "object" }, "displayConfig": { "type": "object" }, "preserved": { "type": "object" }, "entryCount": { "type": "integer" } }, "additionalProperties": false, "required": [ "id", "handle", "address", "instruction", "entryCount" ] } }, "page": { "$ref": "#/$defs/PageInfo" } }, "additionalProperties": false, "required": [ "evaluatedRevision", "total", "items", "page" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - None ## toc.get - Member path: `doc.toc.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a TocInfo object with the instruction, source/display configuration, and entry count. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfContents" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "nodeType": { "const": "tableOfContents" }, "kind": { "const": "block" }, "properties": { "type": "object", "properties": { "instruction": { "type": "string" }, "sourceConfig": { "type": "object" }, "displayConfig": { "type": "object" }, "preservedSwitches": { "type": "object" }, "entryCount": { "type": "integer" } }, "additionalProperties": false, "required": [ "instruction", "entryCount" ] } }, "additionalProperties": false, "required": [ "nodeType", "kind", "properties" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` ### Non-applied receipt codes - None ## toc.configure - Member path: `doc.toc.configure(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TocMutationResult with the updated TOC address on success, or a failure code on no-op. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfContents" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "patch": { "type": "object", "properties": { "outlineLevels": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "useAppliedOutlineLevel": { "type": "boolean" }, "tcFieldIdentifier": { "type": "string" }, "tcFieldLevels": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "hyperlinks": { "type": "boolean" }, "hideInWebView": { "type": "boolean" }, "omitPageNumberLevels": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "separator": { "type": "string" }, "includePageNumbers": { "type": "boolean" }, "tabLeader": { "enum": [ "none", "dot", "hyphen", "underscore", "middleDot" ] }, "rightAlignPageNumbers": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "target", "patch" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "toc": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfContents" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "toc" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_INSERTION_CONTEXT", "PAGE_NUMBERS_NOT_MATERIALIZED" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## toc.update - Member path: `doc.toc.update(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TocMutationResult with the TOC address on success, or a failure code if content is unchanged or page numbers cannot be resolved. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfContents" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "mode": { "enum": [ "all", "pageNumbers" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "toc": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfContents" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "toc" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_INSERTION_CONTEXT", "PAGE_NUMBERS_NOT_MATERIALIZED" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` - `PAGE_NUMBERS_NOT_MATERIALIZED` - `CAPABILITY_UNAVAILABLE` ## toc.remove - Member path: `doc.toc.remove(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TocMutationResult with the removed TOC address on success, or a failure code on no-op. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfContents" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "toc": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfContents" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "toc" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_INSERTION_CONTEXT", "PAGE_NUMBERS_NOT_MATERIALIZED" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## toc.markEntry - Member path: `doc.toc.markEntry(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TocEntryMutationResult with the created entry address on success. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline-insert" }, "anchor": { "type": "object", "properties": { "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeType", "nodeId" ] }, "position": { "enum": [ "start", "end" ] } }, "additionalProperties": false, "required": [ "kind", "anchor" ] }, "text": { "type": "string" }, "level": { "type": "integer", "minimum": 1, "maximum": 9 }, "tableIdentifier": { "type": "string" }, "omitPageNumber": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target", "text" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "entry": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "tableOfContentsEntry" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "entry" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_INSERTION_CONTEXT", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` - `INVALID_INSERTION_CONTEXT` ## toc.unmarkEntry - Member path: `doc.toc.unmarkEntry(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TocEntryMutationResult with the removed entry address on success. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "tableOfContentsEntry" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "entry": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "tableOfContentsEntry" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "entry" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_INSERTION_CONTEXT", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## toc.listEntries - Member path: `doc.toc.listEntries(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a TocListEntriesResult with an array of TC entry discovery items and pagination metadata. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "tableIdentifier": { "type": "string" }, "levelRange": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ResolvedHandle": { "type": "object", "properties": { "ref": { "type": "string" }, "refStability": { "enum": [ "stable", "ephemeral" ] }, "targetKind": { "$ref": "#/$defs/TargetKind" } }, "additionalProperties": false, "required": [ "ref", "refStability", "targetKind" ] }, "TargetKind": { "anyOf": [ { "enum": [ "text", "node", "list", "comment", "trackedChange", "table", "tableCell", "tableOfContents", "section", "sdt", "field" ] }, { "type": "string", "pattern": "^ext:.+$" } ] }, "PageInfo": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "returned": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "limit", "offset", "returned" ] } }, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "$ref": "#/$defs/ResolvedHandle" }, "address": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "tableOfContentsEntry" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "instruction": { "type": "string" }, "text": { "type": "string" }, "level": { "type": "integer" }, "tableIdentifier": { "type": "string" }, "omitPageNumber": { "type": "boolean" } }, "additionalProperties": false, "required": [ "id", "handle", "address", "instruction", "text", "level", "omitPageNumber" ] } }, "page": { "$ref": "#/$defs/PageInfo" } }, "additionalProperties": false, "required": [ "evaluatedRevision", "total", "items", "page" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - None ## toc.getEntry - Member path: `doc.toc.getEntry(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a TocEntryInfo object with the instruction, text, level, and switch configuration. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "tableOfContentsEntry" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "nodeType": { "const": "tableOfContentsEntry" }, "kind": { "const": "inline" }, "properties": { "type": "object", "properties": { "instruction": { "type": "string" }, "text": { "type": "string" }, "level": { "type": "integer" }, "tableIdentifier": { "type": "string" }, "omitPageNumber": { "type": "boolean" } }, "additionalProperties": false, "required": [ "instruction", "text", "level", "omitPageNumber" ] } }, "additionalProperties": false, "required": [ "nodeType", "kind", "properties" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` ### Non-applied receipt codes - None ## toc.editEntry - Member path: `doc.toc.editEntry(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a TocEntryMutationResult with the updated entry address on success, or NO_OP if no change. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "tableOfContentsEntry" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "patch": { "type": "object", "properties": { "text": { "type": "string" }, "level": { "type": "integer", "minimum": 1, "maximum": 9 }, "tableIdentifier": { "type": "string" }, "omitPageNumber": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "target", "patch" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "entry": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "tableOfContentsEntry" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "entry" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_INSERTION_CONTEXT", "INVALID_INPUT" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` # Images operations Image lifecycle, placement, and wrap configuration. ## images.list - Member path: `doc.images.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an ImagesListResult with total count and image summaries. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "offset": { "type": "integer" }, "limit": { "type": "integer" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": false, "required": [ "total", "items" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - None ## images.get - Member path: `doc.images.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an ImageSummary with full image properties. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" } }, "additionalProperties": false, "required": [ "imageId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` ### Non-applied receipt codes - None ## images.delete - Member path: `doc.images.delete(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult indicating success or failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" } }, "additionalProperties": false, "required": [ "imageId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## images.move - Member path: `doc.images.move(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult indicating success or failure. Tracked-mode results include `trackedChangeRefs` pointing at the paired move review entity. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "imageId": { "type": "string" }, "to": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "inParagraph" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "kind", "target" ] } ] } }, "additionalProperties": false, "required": [ "imageId", "to" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` - `CAPABILITY_UNAVAILABLE` ## images.convertToInline - Member path: `doc.images.convertToInline(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if already inline. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" } }, "additionalProperties": false, "required": [ "imageId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## images.convertToFloating - Member path: `doc.images.convertToFloating(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if already floating. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" } }, "additionalProperties": false, "required": [ "imageId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## images.setSize - Member path: `doc.images.setSize(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if the size already matches. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "size": { "type": "object", "properties": { "width": { "type": "number", "exclusiveMinimum": 0 }, "height": { "type": "number", "exclusiveMinimum": 0 }, "unit": { "type": "string", "enum": [ "px", "pt", "twip" ] } }, "additionalProperties": false, "required": [ "width", "height" ] } }, "additionalProperties": false, "required": [ "imageId", "size" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.setWrapType - Member path: `doc.images.setWrapType(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if already set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "type": { "type": "string", "enum": [ "None", "Square", "Through", "Tight", "TopAndBottom", "Inline" ] } }, "additionalProperties": false, "required": [ "imageId", "type" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## images.setWrapSide - Member path: `doc.images.setWrapSide(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if already set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "side": { "type": "string", "enum": [ "bothSides", "left", "right", "largest" ] } }, "additionalProperties": false, "required": [ "imageId", "side" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## images.setWrapDistances - Member path: `doc.images.setWrapDistances(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if already set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "distances": { "type": "object", "properties": { "distTop": { "type": "number" }, "distBottom": { "type": "number" }, "distLeft": { "type": "number" }, "distRight": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "imageId", "distances" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## images.setPosition - Member path: `doc.images.setPosition(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "position": { "type": "object", "properties": { "hRelativeFrom": { "type": "string" }, "vRelativeFrom": { "type": "string" }, "alignH": { "type": "string" }, "alignV": { "type": "string" }, "marginOffset": { "type": "object", "properties": { "horizontal": { "type": "number" }, "top": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "imageId", "position" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## images.setAnchorOptions - Member path: `doc.images.setAnchorOptions(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "options": { "type": "object", "properties": { "behindDoc": { "type": "boolean" }, "allowOverlap": { "type": "boolean" }, "layoutInCell": { "type": "boolean" }, "lockAnchor": { "type": "boolean" }, "simplePos": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "imageId", "options" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## images.setZOrder - Member path: `doc.images.setZOrder(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "zOrder": { "type": "object", "properties": { "relativeHeight": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "additionalProperties": false, "required": [ "relativeHeight" ] } }, "additionalProperties": false, "required": [ "imageId", "zOrder" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## images.scale - Member path: `doc.images.scale(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult with the updated image address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "factor": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "imageId", "factor" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.setLockAspectRatio - Member path: `doc.images.setLockAspectRatio(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if already set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "locked": { "type": "boolean" } }, "additionalProperties": false, "required": [ "imageId", "locked" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.rotate - Member path: `doc.images.rotate(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if already set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "angle": { "type": "number", "minimum": 0, "maximum": 360 } }, "additionalProperties": false, "required": [ "imageId", "angle" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.flip - Member path: `doc.images.flip(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if already set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "horizontal": { "type": "boolean" }, "vertical": { "type": "boolean" } }, "additionalProperties": false, "required": [ "imageId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.crop - Member path: `doc.images.crop(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "crop": { "type": "object", "properties": { "left": { "type": "number", "minimum": 0, "maximum": 100 }, "top": { "type": "number", "minimum": 0, "maximum": 100 }, "right": { "type": "number", "minimum": 0, "maximum": 100 }, "bottom": { "type": "number", "minimum": 0, "maximum": 100 } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "imageId", "crop" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.resetCrop - Member path: `doc.images.resetCrop(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if no crop is set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" } }, "additionalProperties": false, "required": [ "imageId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## images.replaceSource - Member path: `doc.images.replaceSource(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult with the updated image address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "src": { "type": "string" }, "resetSize": { "type": "boolean" } }, "additionalProperties": false, "required": [ "imageId", "src" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.setAltText - Member path: `doc.images.setAltText(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "required": [ "imageId", "description" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.setDecorative - Member path: `doc.images.setDecorative(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "decorative": { "type": "boolean" } }, "additionalProperties": false, "required": [ "imageId", "decorative" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.setName - Member path: `doc.images.setName(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "imageId", "name" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.setHyperlink - Member path: `doc.images.setHyperlink(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "url": { "type": [ "string", "null" ] }, "tooltip": { "type": "string" } }, "additionalProperties": false, "required": [ "imageId", "url" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.insertCaption - Member path: `doc.images.insertCaption(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an ImagesMutationResult with the image address. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "imageId", "text" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.updateCaption - Member path: `doc.images.updateCaption(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if text unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "imageId", "text" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## images.removeCaption - Member path: `doc.images.removeCaption(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an ImagesMutationResult; reports NO_OP if no caption exists. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "imageId": { "type": "string" } }, "additionalProperties": false, "required": [ "imageId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "image": { "type": "object" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `AMBIGUOUS_TARGET` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` # Hyperlinks operations Hyperlink discovery, creation, and metadata management. ## hyperlinks.list - Member path: `doc.hyperlinks.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a HyperlinksListResult with an array of hyperlink discovery items and pagination metadata. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "within": { "$ref": "#/$defs/BlockNodeAddress" }, "hrefPattern": { "type": "string" }, "anchor": { "type": "string" }, "textPattern": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] }, "PageInfo": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "returned": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "limit", "offset", "returned" ] } }, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "hyperlink" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "properties": { "type": "object", "properties": { "href": { "type": "string" }, "anchor": { "type": "string" }, "docLocation": { "type": "string" }, "tooltip": { "type": "string" }, "target": { "type": "string" }, "rel": { "type": "string" } }, "additionalProperties": false }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "address", "properties" ] } }, "page": { "$ref": "#/$defs/PageInfo" } }, "additionalProperties": false, "required": [ "evaluatedRevision", "total", "items", "page" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - None ## hyperlinks.get - Member path: `doc.hyperlinks.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a HyperlinkInfo object with the address, destination properties, and display text. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "hyperlink" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "address": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "hyperlink" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "properties": { "type": "object", "properties": { "href": { "type": "string" }, "anchor": { "type": "string" }, "docLocation": { "type": "string" }, "tooltip": { "type": "string" }, "target": { "type": "string" }, "rel": { "type": "string" } }, "additionalProperties": false }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "address", "properties" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` ### Non-applied receipt codes - None ## hyperlinks.wrap - Member path: `doc.hyperlinks.wrap(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a HyperlinkMutationResult with the created hyperlink address on success, or a failure code on no-op. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TextAddress" }, "link": { "type": "object", "properties": { "destination": { "type": "object", "properties": { "href": { "type": "string" }, "anchor": { "type": "string" }, "docLocation": { "type": "string" } }, "additionalProperties": false }, "tooltip": { "type": "string" }, "target": { "type": "string" }, "rel": { "type": "string" } }, "additionalProperties": false, "required": [ "destination" ] } }, "additionalProperties": false, "required": [ "target", "link" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "hyperlink": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "hyperlink" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "hyperlink" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": { "type": "object" } }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## hyperlinks.insert - Member path: `doc.hyperlinks.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a HyperlinkMutationResult with the created hyperlink address on success, or a failure code. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/TextAddress" }, "text": { "type": "string" }, "link": { "type": "object", "properties": { "destination": { "type": "object", "properties": { "href": { "type": "string" }, "anchor": { "type": "string" }, "docLocation": { "type": "string" } }, "additionalProperties": false }, "tooltip": { "type": "string" }, "target": { "type": "string" }, "rel": { "type": "string" } }, "additionalProperties": false, "required": [ "destination" ] } }, "additionalProperties": false, "required": [ "text", "link" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "hyperlink": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "hyperlink" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "hyperlink" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": { "type": "object" } }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` ## hyperlinks.patch - Member path: `doc.hyperlinks.patch(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a HyperlinkMutationResult with the updated hyperlink address on success, or NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "hyperlink" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "patch": { "type": "object", "properties": { "href": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "anchor": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "docLocation": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "tooltip": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "target": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "rel": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "target", "patch" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "hyperlink": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "hyperlink" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "hyperlink" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": { "type": "object" } }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` ## hyperlinks.remove - Member path: `doc.hyperlinks.remove(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a HyperlinkMutationResult with the removed hyperlink address on success, or a failure code on no-op. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "hyperlink" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "mode": { "enum": [ "unwrap", "deleteText" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "hyperlink": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "hyperlink" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "hyperlink" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": { "type": "object" } }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - `NO_OP` # Headers & Footers operations Structure, references, and part lifecycle for document headers and footers. ## headerFooters.list - Member path: `doc.headerFooters.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a paginated DiscoveryOutput of HeaderFooterSlotEntry items. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "kind": { "enum": [ "header", "footer" ] }, "section": { "$ref": "#/$defs/SectionAddress" }, "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ResolvedHandle": { "type": "object", "properties": { "ref": { "type": "string" }, "refStability": { "enum": [ "stable", "ephemeral" ] }, "targetKind": { "$ref": "#/$defs/TargetKind" } }, "additionalProperties": false, "required": [ "ref", "refStability", "targetKind" ] }, "TargetKind": { "anyOf": [ { "enum": [ "text", "node", "list", "comment", "trackedChange", "table", "tableCell", "tableOfContents", "section", "sdt", "field" ] }, { "type": "string", "pattern": "^ext:.+$" } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "PageInfo": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "returned": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "limit", "offset", "returned" ] } }, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "$ref": "#/$defs/ResolvedHandle" }, "section": { "$ref": "#/$defs/SectionAddress" }, "sectionIndex": { "type": "integer", "minimum": 0 }, "kind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "refId": { "type": [ "string", "null" ] }, "isExplicit": { "type": "boolean" } }, "additionalProperties": false, "required": [ "id", "handle", "section", "sectionIndex", "kind", "variant", "isExplicit" ] } }, "page": { "$ref": "#/$defs/PageInfo" } }, "additionalProperties": false, "required": [ "evaluatedRevision", "total", "items", "page" ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `INVALID_TARGET` ### Non-applied receipt codes - None ## headerFooters.get - Member path: `doc.headerFooters.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a HeaderFooterSlotEntry for the targeted section slot. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] } }, "additionalProperties": false, "required": [ "kind", "section", "headerFooterKind", "variant" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "section": { "$ref": "#/$defs/SectionAddress" }, "sectionIndex": { "type": "integer", "minimum": 0 }, "kind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "refId": { "type": [ "string", "null" ] }, "isExplicit": { "type": "boolean" } }, "additionalProperties": false, "required": [ "section", "sectionIndex", "kind", "variant", "isExplicit" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - None ## headerFooters.resolve - Member path: `doc.headerFooters.resolve(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a HeaderFooterResolveResult indicating explicit, inherited, or none status with the resolved refId. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] } }, "additionalProperties": false, "required": [ "kind", "section", "headerFooterKind", "variant" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "status": { "const": "explicit" }, "refId": { "type": "string" }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "status", "refId", "section" ] }, { "type": "object", "properties": { "status": { "const": "inherited" }, "refId": { "type": "string" }, "resolvedFromSection": { "$ref": "#/$defs/SectionAddress" }, "resolvedVariant": { "enum": [ "default", "first", "even" ] } }, "additionalProperties": false, "required": [ "status", "refId", "resolvedFromSection", "resolvedVariant" ] }, { "type": "object", "properties": { "status": { "const": "none" } }, "additionalProperties": false, "required": [ "status" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` ### Non-applied receipt codes - None ## headerFooters.refs.set - Member path: `doc.headerFooters.refs.set(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if the reference already matches, INVALID_TARGET if the relationship does not exist. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] } }, "additionalProperties": false, "required": [ "kind", "section", "headerFooterKind", "variant" ] }, "refId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "target", "refId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## headerFooters.refs.clear - Member path: `doc.headerFooters.refs.clear(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if no explicit reference existed. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] } }, "additionalProperties": false, "required": [ "kind", "section", "headerFooterKind", "variant" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` ## headerFooters.refs.setLinkedToPrevious - Member path: `doc.headerFooters.refs.setLinkedToPrevious(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a SectionMutationResult receipt; reports NO_OP if the link state already matches, INVALID_TARGET for the first section. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] } }, "additionalProperties": false, "required": [ "kind", "section", "headerFooterKind", "variant" ] }, "linked": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target", "linked" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "section": { "$ref": "#/$defs/SectionAddress" } }, "additionalProperties": false, "required": [ "success", "section" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `NO_OP` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ## headerFooters.parts.list - Member path: `doc.headerFooters.parts.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a paginated DiscoveryOutput of HeaderFooterPartEntry items. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "kind": { "enum": [ "header", "footer" ] }, "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ResolvedHandle": { "type": "object", "properties": { "ref": { "type": "string" }, "refStability": { "enum": [ "stable", "ephemeral" ] }, "targetKind": { "$ref": "#/$defs/TargetKind" } }, "additionalProperties": false, "required": [ "ref", "refStability", "targetKind" ] }, "TargetKind": { "anyOf": [ { "enum": [ "text", "node", "list", "comment", "trackedChange", "table", "tableCell", "tableOfContents", "section", "sdt", "field" ] }, { "type": "string", "pattern": "^ext:.+$" } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "PageInfo": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "returned": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "limit", "offset", "returned" ] } }, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "$ref": "#/$defs/ResolvedHandle" }, "refId": { "type": "string" }, "kind": { "enum": [ "header", "footer" ] }, "partPath": { "type": "string" }, "referencedBySections": { "type": "array", "items": { "$ref": "#/$defs/SectionAddress" } } }, "additionalProperties": false, "required": [ "id", "handle", "refId", "kind", "partPath", "referencedBySections" ] } }, "page": { "$ref": "#/$defs/PageInfo" } }, "additionalProperties": false, "required": [ "evaluatedRevision", "total", "items", "page" ] } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## headerFooters.parts.create - Member path: `doc.headerFooters.parts.create(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a HeaderFooterPartsMutationResult with the new refId/partPath on success, INVALID_TARGET failure when sourceRefId is invalid or mismatched. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "kind": { "enum": [ "header", "footer" ] }, "sourceRefId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "refId": { "type": "string" }, "partPath": { "type": "string" } }, "additionalProperties": false, "required": [ "success", "refId", "partPath" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `INVALID_TARGET` ## headerFooters.parts.delete - Member path: `doc.headerFooters.parts.delete(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a HeaderFooterPartsMutationResult on success; INVALID_TARGET failure if sections still reference the part. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "headerFooterPart" }, "refId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "refId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "refId": { "type": "string" }, "partPath": { "type": "string" } }, "additionalProperties": false, "required": [ "success", "refId", "partPath" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_TARGET" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `INTERNAL_ERROR` ### Non-applied receipt codes - `INVALID_TARGET` # Content Controls operations Content control (SDT) discovery, mutation, typed controls, and Word compatibility. ## create.contentControl - Member path: `doc.create.contentControl(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the created content control target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "controlType": { "type": "string" }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "at": { "$ref": "#/$defs/SelectionTarget" }, "tag": { "type": "string" }, "alias": { "type": "string" }, "lockMode": { "enum": [ "unlocked", "sdtLocked", "contentLocked", "sdtContentLocked" ] }, "content": { "type": "string" }, "html": { "type": "string" }, "json": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "additionalProperties": false, "required": [ "kind" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_TARGET` - `NO_OP` ## contentControls.list - Member path: `doc.contentControls.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ContentControlsListResult with items and total count. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "controlType": { "type": "string" }, "tag": { "type": "string" }, "offset": { "type": "integer" }, "limit": { "type": "integer" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "nodeType": { "const": "sdt" }, "kind": { "enum": [ "block", "inline" ] }, "id": { "type": "string" }, "controlType": { "type": "string" }, "lockMode": { "type": "string" }, "properties": { "type": "object" }, "binding": { "type": "object", "properties": { "storeItemId": { "type": "string" }, "xpath": { "type": "string" }, "prefixMappings": { "type": "string" } }, "additionalProperties": false, "required": [ "storeItemId", "xpath" ] }, "raw": { "type": "object" }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "selectionTarget": { "oneOf": [ { "$ref": "#/$defs/SelectionTarget" }, { "type": "null" } ] }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeType", "kind", "id", "controlType", "lockMode", "properties", "target" ] } }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "items", "total" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.get - Member path: `doc.contentControls.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ContentControlInfo with full properties. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "nodeType": { "const": "sdt" }, "kind": { "enum": [ "block", "inline" ] }, "id": { "type": "string" }, "controlType": { "type": "string" }, "lockMode": { "type": "string" }, "properties": { "type": "object" }, "binding": { "type": "object", "properties": { "storeItemId": { "type": "string" }, "xpath": { "type": "string" }, "prefixMappings": { "type": "string" } }, "additionalProperties": false, "required": [ "storeItemId", "xpath" ] }, "raw": { "type": "object" }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "selectionTarget": { "oneOf": [ { "$ref": "#/$defs/SelectionTarget" }, { "type": "null" } ] }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeType", "kind", "id", "controlType", "lockMode", "properties", "target" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.listInRange - Member path: `doc.contentControls.listInRange(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ContentControlsListResult scoped to the range. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "startBlockId": { "type": "string" }, "endBlockId": { "type": "string" }, "offset": { "type": "integer" }, "limit": { "type": "integer" } }, "additionalProperties": false, "required": [ "startBlockId", "endBlockId" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "nodeType": { "const": "sdt" }, "kind": { "enum": [ "block", "inline" ] }, "id": { "type": "string" }, "controlType": { "type": "string" }, "lockMode": { "type": "string" }, "properties": { "type": "object" }, "binding": { "type": "object", "properties": { "storeItemId": { "type": "string" }, "xpath": { "type": "string" }, "prefixMappings": { "type": "string" } }, "additionalProperties": false, "required": [ "storeItemId", "xpath" ] }, "raw": { "type": "object" }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "selectionTarget": { "oneOf": [ { "$ref": "#/$defs/SelectionTarget" }, { "type": "null" } ] }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeType", "kind", "id", "controlType", "lockMode", "properties", "target" ] } }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "items", "total" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.selectByTag - Member path: `doc.contentControls.selectByTag(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ContentControlsListResult with matching items. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "tag": { "type": "string" }, "offset": { "type": "integer" }, "limit": { "type": "integer" } }, "additionalProperties": false, "required": [ "tag" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "nodeType": { "const": "sdt" }, "kind": { "enum": [ "block", "inline" ] }, "id": { "type": "string" }, "controlType": { "type": "string" }, "lockMode": { "type": "string" }, "properties": { "type": "object" }, "binding": { "type": "object", "properties": { "storeItemId": { "type": "string" }, "xpath": { "type": "string" }, "prefixMappings": { "type": "string" } }, "additionalProperties": false, "required": [ "storeItemId", "xpath" ] }, "raw": { "type": "object" }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "selectionTarget": { "oneOf": [ { "$ref": "#/$defs/SelectionTarget" }, { "type": "null" } ] }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeType", "kind", "id", "controlType", "lockMode", "properties", "target" ] } }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "items", "total" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.selectByTitle - Member path: `doc.contentControls.selectByTitle(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ContentControlsListResult with matching items. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "title": { "type": "string" }, "offset": { "type": "integer" }, "limit": { "type": "integer" } }, "additionalProperties": false, "required": [ "title" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "nodeType": { "const": "sdt" }, "kind": { "enum": [ "block", "inline" ] }, "id": { "type": "string" }, "controlType": { "type": "string" }, "lockMode": { "type": "string" }, "properties": { "type": "object" }, "binding": { "type": "object", "properties": { "storeItemId": { "type": "string" }, "xpath": { "type": "string" }, "prefixMappings": { "type": "string" } }, "additionalProperties": false, "required": [ "storeItemId", "xpath" ] }, "raw": { "type": "object" }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "selectionTarget": { "oneOf": [ { "$ref": "#/$defs/SelectionTarget" }, { "type": "null" } ] }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeType", "kind", "id", "controlType", "lockMode", "properties", "target" ] } }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "items", "total" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.listChildren - Member path: `doc.contentControls.listChildren(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ContentControlsListResult with child items. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "offset": { "type": "integer" }, "limit": { "type": "integer" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "nodeType": { "const": "sdt" }, "kind": { "enum": [ "block", "inline" ] }, "id": { "type": "string" }, "controlType": { "type": "string" }, "lockMode": { "type": "string" }, "properties": { "type": "object" }, "binding": { "type": "object", "properties": { "storeItemId": { "type": "string" }, "xpath": { "type": "string" }, "prefixMappings": { "type": "string" } }, "additionalProperties": false, "required": [ "storeItemId", "xpath" ] }, "raw": { "type": "object" }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "selectionTarget": { "oneOf": [ { "$ref": "#/$defs/SelectionTarget" }, { "type": "null" } ] }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeType", "kind", "id", "controlType", "lockMode", "properties", "target" ] } }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "items", "total" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.getParent - Member path: `doc.contentControls.getParent(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ContentControlInfo for the parent, or null if no parent SDT exists. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "oneOf": [ { "type": "object", "properties": { "nodeType": { "const": "sdt" }, "kind": { "enum": [ "block", "inline" ] }, "id": { "type": "string" }, "controlType": { "type": "string" }, "lockMode": { "type": "string" }, "properties": { "type": "object" }, "binding": { "type": "object", "properties": { "storeItemId": { "type": "string" }, "xpath": { "type": "string" }, "prefixMappings": { "type": "string" } }, "additionalProperties": false, "required": [ "storeItemId", "xpath" ] }, "raw": { "type": "object" }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "selectionTarget": { "oneOf": [ { "$ref": "#/$defs/SelectionTarget" }, { "type": "null" } ] }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeType", "kind", "id", "controlType", "lockMode", "properties", "target" ] }, { "type": "null" } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.wrap - Member path: `doc.contentControls.wrap(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the wrapper target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "tag": { "type": "string" }, "alias": { "type": "string" }, "lockMode": { "enum": [ "unlocked", "sdtLocked", "contentLocked", "sdtContentLocked" ] } }, "additionalProperties": false, "required": [ "kind", "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.unwrap - Member path: `doc.contentControls.unwrap(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if already unwrapped. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.delete - Member path: `doc.contentControls.delete(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if already removed. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.copy - Member path: `doc.contentControls.copy(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the copied content control target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "destination": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target", "destination" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.move - Member path: `doc.contentControls.move(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the updated target position. Tracked-mode results include `trackedChangeRefs` pointing at the paired move review entity. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "destination": { "oneOf": [ { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "inParagraph" }, "target": { "$ref": "#/$defs/BlockNodeAddress" }, "offset": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "kind", "target" ] } ] } }, "additionalProperties": false, "required": [ "target", "destination" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` - `CAPABILITY_UNAVAILABLE` ## contentControls.patch - Member path: `doc.contentControls.patch(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if no fields changed. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "alias": {}, "tag": {}, "appearance": { "enum": [ "boundingBox", "tags", "hidden" ] }, "color": { "type": "string" }, "placeholder": { "type": "string" }, "showingPlaceholder": { "type": "boolean" }, "temporary": { "type": "boolean" }, "tabIndex": { "type": "integer" } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.setLockMode - Member path: `doc.contentControls.setLockMode(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if lock mode unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "lockMode": { "enum": [ "unlocked", "sdtLocked", "contentLocked", "sdtContentLocked" ] } }, "additionalProperties": false, "required": [ "target", "lockMode" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.setType - Member path: `doc.contentControls.setType(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if type unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "controlType": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "controlType" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.getContent - Member path: `doc.contentControls.getContent(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ContentControlsGetContentResult with the content string and format. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "content": { "type": "string" }, "format": { "enum": [ "text", "html" ] } }, "additionalProperties": false, "required": [ "content", "format" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.replaceContent - Member path: `doc.contentControls.replaceContent(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the updated target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "content": { "type": "string" }, "format": { "enum": [ "text", "html" ] } }, "additionalProperties": false, "required": [ "target", "content" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.clearContent - Member path: `doc.contentControls.clearContent(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if already empty. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.appendContent - Member path: `doc.contentControls.appendContent(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the updated target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "content": { "type": "string" }, "format": { "enum": [ "text", "html" ] } }, "additionalProperties": false, "required": [ "target", "content" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.prependContent - Member path: `doc.contentControls.prependContent(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the updated target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "content": { "type": "string" }, "format": { "enum": [ "text", "html" ] } }, "additionalProperties": false, "required": [ "target", "content" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.insertBefore - Member path: `doc.contentControls.insertBefore(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "content": { "type": "string" }, "format": { "enum": [ "text", "html" ] } }, "additionalProperties": false, "required": [ "target", "content" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.insertAfter - Member path: `doc.contentControls.insertAfter(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "content": { "type": "string" }, "format": { "enum": [ "text", "html" ] } }, "additionalProperties": false, "required": [ "target", "content" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.getBinding - Member path: `doc.contentControls.getBinding(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns the ContentControlBinding or null if no binding is set. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "storeItemId": { "type": "string" }, "xpath": { "type": "string" }, "prefixMappings": { "type": "string" } }, "additionalProperties": false, "required": [ "storeItemId", "xpath" ] }, { "type": "null" } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.setBinding - Member path: `doc.contentControls.setBinding(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if binding unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "storeItemId": { "type": "string" }, "xpath": { "type": "string" }, "prefixMappings": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "storeItemId", "xpath" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.clearBinding - Member path: `doc.contentControls.clearBinding(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if no binding existed. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.getRawProperties - Member path: `doc.contentControls.getRawProperties(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ContentControlsGetRawPropertiesResult with the raw properties. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "properties": { "type": "object" } }, "additionalProperties": false, "required": [ "properties" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.patchRawProperties - Member path: `doc.contentControls.patchRawProperties(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if no effective changes. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "patches": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": false, "required": [ "target", "patches" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.validateWordCompatibility - Member path: `doc.contentControls.validateWordCompatibility(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a compatibility result with diagnostics. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "compatible": { "type": "boolean" }, "diagnostics": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": false, "required": [ "compatible", "diagnostics" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.normalizeWordCompatibility - Member path: `doc.contentControls.normalizeWordCompatibility(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if already compatible. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.normalizeTagPayload - Member path: `doc.contentControls.normalizeTagPayload(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if already normalized. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## contentControls.text.setMultiline - Member path: `doc.contentControls.text.setMultiline(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "multiline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target", "multiline" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.text.setValue - Member path: `doc.contentControls.text.setValue(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "value": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "value" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.text.clearValue - Member path: `doc.contentControls.text.clearValue(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if already empty. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.date.setValue - Member path: `doc.contentControls.date.setValue(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "value": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "value" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.date.clearValue - Member path: `doc.contentControls.date.clearValue(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if already empty. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.date.setDisplayFormat - Member path: `doc.contentControls.date.setDisplayFormat(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "format": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "format" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.date.setDisplayLocale - Member path: `doc.contentControls.date.setDisplayLocale(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "locale": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "locale" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.date.setStorageFormat - Member path: `doc.contentControls.date.setStorageFormat(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "format": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "format" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.date.setCalendar - Member path: `doc.contentControls.date.setCalendar(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "calendar": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "calendar" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.checkbox.getState - Member path: `doc.contentControls.checkbox.getState(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CheckboxGetStateResult with the checked boolean. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "checked": { "type": "boolean" } }, "additionalProperties": false, "required": [ "checked" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - None ## contentControls.checkbox.setState - Member path: `doc.contentControls.checkbox.setState(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "checked": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target", "checked" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.checkbox.toggle - Member path: `doc.contentControls.checkbox.toggle(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the updated state. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.checkbox.setSymbolPair - Member path: `doc.contentControls.checkbox.setSymbolPair(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if symbols unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "checkedSymbol": { "type": "object" }, "uncheckedSymbol": { "type": "object" } }, "additionalProperties": false, "required": [ "target", "checkedSymbol", "uncheckedSymbol" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.choiceList.getItems - Member path: `doc.contentControls.choiceList.getItems(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ChoiceListGetItemsResult with items and selectedValue. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "selectedValue": { "type": "string" } }, "additionalProperties": false, "required": [ "items" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - None ## contentControls.choiceList.setItems - Member path: `doc.contentControls.choiceList.setItems(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if items unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "items": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": false, "required": [ "target", "items" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.choiceList.setSelected - Member path: `doc.contentControls.choiceList.setSelected(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if selection unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "value": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "value" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.repeatingSection.listItems - Member path: `doc.contentControls.repeatingSection.listItems(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a RepeatingSectionListItemsResult with child item info. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "nodeType": { "const": "sdt" }, "kind": { "enum": [ "block", "inline" ] }, "id": { "type": "string" }, "controlType": { "type": "string" }, "lockMode": { "type": "string" }, "properties": { "type": "object" }, "binding": { "type": "object", "properties": { "storeItemId": { "type": "string" }, "xpath": { "type": "string" }, "prefixMappings": { "type": "string" } }, "additionalProperties": false, "required": [ "storeItemId", "xpath" ] }, "raw": { "type": "object" }, "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "selectionTarget": { "oneOf": [ { "$ref": "#/$defs/SelectionTarget" }, { "type": "null" } ] }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeType", "kind", "id", "controlType", "lockMode", "properties", "target" ] } }, "total": { "type": "integer" } }, "additionalProperties": false, "required": [ "items", "total" ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - None ## contentControls.repeatingSection.insertItemBefore - Member path: `doc.contentControls.repeatingSection.insertItemBefore(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the new item target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "index": { "type": "integer" } }, "additionalProperties": false, "required": [ "target", "index" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.repeatingSection.insertItemAfter - Member path: `doc.contentControls.repeatingSection.insertItemAfter(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the new item target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "index": { "type": "integer" } }, "additionalProperties": false, "required": [ "target", "index" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.repeatingSection.cloneItem - Member path: `doc.contentControls.repeatingSection.cloneItem(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the cloned item target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "index": { "type": "integer" } }, "additionalProperties": false, "required": [ "target", "index" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.repeatingSection.deleteItem - Member path: `doc.contentControls.repeatingSection.deleteItem(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if item does not exist. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "index": { "type": "integer" } }, "additionalProperties": false, "required": [ "target", "index" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.repeatingSection.setAllowInsertDelete - Member path: `doc.contentControls.repeatingSection.setAllowInsertDelete(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if unchanged. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "allow": { "type": "boolean" } }, "additionalProperties": false, "required": [ "target", "allow" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` ## contentControls.group.wrap - Member path: `doc.contentControls.group.wrap(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult with the new group wrapper target. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## contentControls.group.ungroup - Member path: `doc.contentControls.group.ungroup(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ContentControlMutationResult; reports NO_OP if not a group. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "contentControl": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "updatedRef": { "type": "object", "properties": { "kind": { "enum": [ "block", "inline" ] }, "nodeType": { "const": "sdt" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "contentControl" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "$ref": "#/$defs/ReceiptFailure" } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `AMBIGUOUS_TARGET` - `INVALID_INPUT` - `LOCK_VIOLATION` - `REVISION_MISMATCH` - `CAPABILITY_UNAVAILABLE` - `TYPE_MISMATCH` ### Non-applied receipt codes - `NO_OP` # Bookmarks operations Named bookmark inspection, insertion, renaming, and removal. ## bookmarks.list - Member path: `doc.bookmarks.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a BookmarksListResult containing discovered bookmarks with address and domain data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 }, "in": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## bookmarks.get - Member path: `doc.bookmarks.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a BookmarkInfo object with the bookmark's name, range, and optional table-column data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## bookmarks.insert - Member path: `doc.bookmarks.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a BookmarkMutationResult indicating success with the bookmark address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "name": { "type": "string" }, "at": { "$ref": "#/$defs/TextTarget" }, "tableColumn": { "type": "object", "properties": { "colFirst": { "type": "integer" }, "colLast": { "type": "integer" } }, "additionalProperties": false, "required": [ "colFirst", "colLast" ] } }, "additionalProperties": false, "required": [ "name", "at" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "bookmark": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] } }, "additionalProperties": false, "required": [ "success", "bookmark" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## bookmarks.rename - Member path: `doc.bookmarks.rename(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a BookmarkMutationResult indicating success with the updated bookmark address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "newName": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "newName" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "bookmark": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] } }, "additionalProperties": false, "required": [ "success", "bookmark" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## bookmarks.remove - Member path: `doc.bookmarks.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a BookmarkMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "bookmark": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] } }, "additionalProperties": false, "required": [ "success", "bookmark" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Footnotes operations Footnote and endnote lifecycle and numbering configuration. ## footnotes.list - Member path: `doc.footnotes.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a FootnotesListResult containing discovered footnotes with address and domain data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "type": { "enum": [ "footnote", "endnote" ] }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## footnotes.get - Member path: `doc.footnotes.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a FootnoteInfo object with the note's type, display number, and content. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "noteId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## footnotes.insert - Member path: `doc.footnotes.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a FootnoteMutationResult indicating success with the footnote address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "oneOf": [ { "type": "object", "properties": { "at": { "$ref": "#/$defs/TextTarget" }, "type": { "enum": [ "footnote", "endnote" ] }, "content": { "type": "string" } }, "additionalProperties": false, "required": [ "type", "content" ] }, { "type": "object", "properties": { "at": { "$ref": "#/$defs/TextTarget" }, "type": { "enum": [ "footnote", "endnote" ] }, "body": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ], "description": "Structured SDM/1 note body." } }, "additionalProperties": false, "required": [ "type", "body" ] } ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "footnote": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "noteId" ] } }, "additionalProperties": false, "required": [ "success", "footnote" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_FRAGMENT` - `CAPABILITY_UNAVAILABLE` ## footnotes.update - Member path: `doc.footnotes.update(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a FootnoteMutationResult indicating success with the updated footnote address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "noteId" ] }, "patch": { "oneOf": [ { "type": "object", "properties": { "content": { "type": "string" } }, "additionalProperties": false, "required": [ "content" ] }, { "type": "object", "properties": { "body": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ], "description": "Structured SDM/1 note body patch." } }, "additionalProperties": false, "required": [ "body" ] }, { "type": "object", "properties": {}, "additionalProperties": false } ] } }, "additionalProperties": false, "required": [ "target", "patch" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "footnote": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "noteId" ] } }, "additionalProperties": false, "required": [ "success", "footnote" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_FRAGMENT` - `CAPABILITY_UNAVAILABLE` ## footnotes.remove - Member path: `doc.footnotes.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a FootnoteMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "noteId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "footnote": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "noteId" ] } }, "additionalProperties": false, "required": [ "success", "footnote" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## footnotes.configure - Member path: `doc.footnotes.configure(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a FootnoteConfigResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "type": { "enum": [ "footnote", "endnote" ] }, "scope": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "document" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } ] }, "numbering": { "type": "object", "properties": { "format": { "enum": [ "decimal", "lowerRoman", "upperRoman", "lowerLetter", "upperLetter", "symbol" ] }, "start": { "type": "integer" }, "restartPolicy": { "enum": [ "continuous", "eachSection", "eachPage" ] }, "position": { "enum": [ "pageBottom", "beneathText", "sectionEnd", "documentEnd" ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "type", "scope" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Clipboard operations Clipboard parsing, model insertion, and selection serialization. ## clipboard.parse - Member path: `doc.clipboard.parse(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ClipboardParseResult with a ClipboardInsertPlan or a named fail-closed reason. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "source": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "kind": { "enum": [ "string", "bytes" ] }, "data": {}, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "type", "kind", "data" ] } } }, "additionalProperties": false, "required": [ "items" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "success": { "type": "boolean" }, "plan": { "type": "object" }, "diagnostics": { "type": "array" }, "failure": { "type": "object" } }, "additionalProperties": false } ``` ### Pre-apply throws - None ### Non-applied receipt codes - `INVALID_INPUT` - `INVALID_PAYLOAD` - `EMPTY_FRAGMENT` - `CAPABILITY_UNSUPPORTED` - `INVALID_FRAGMENT` - `CAPABILITY_UNAVAILABLE` ## clipboard.insert - Member path: `doc.clipboard.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: yes - Supports dry run: yes ### Expected result Returns a ClipboardInsertResult with inserted refs, diagnostics, and one paste transaction receipt, or a named fail-closed reason. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "payload": { "type": "object" }, "plan": { "type": "object" }, "fragment": { "type": "object" }, "target": { "type": "object" }, "changeMode": { "enum": [ "direct", "tracked" ] }, "fallback": { "enum": [ "reject-rich", "plain-with-warning" ] } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "ReceiptSuccess": { "type": "object", "properties": { "success": { "const": true }, "id": { "type": "string" }, "inserted": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "updated": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "removed": { "type": "array", "items": { "$ref": "#/$defs/EntityAddress" } }, "invalidatedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRef" } }, "remappedRefs": { "type": "array", "items": { "$ref": "#/$defs/AffectedRefRemapping" } }, "affectedStories": { "type": "array", "items": { "$ref": "#/$defs/StoryLocator" } }, "textRangeShifts": { "type": "array", "items": { "$ref": "#/$defs/TextRangeShift" } }, "txId": { "type": "string" } }, "additionalProperties": false, "required": [ "success" ] }, "EntityAddress": { "oneOf": [ { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" } ] }, "CommentAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "comment" }, "entityId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "TrackedChangeAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "trackedChange" }, "entityId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "entityId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "AffectedRef": { "oneOf": [ { "$ref": "#/$defs/TextAddress" }, { "$ref": "#/$defs/BookmarkAddress" }, { "$ref": "#/$defs/CommentAddress" }, { "$ref": "#/$defs/TrackedChangeAddress" }, { "$ref": "#/$defs/BlockNavigationAddress" } ] }, "TextAddress": { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "BookmarkAddress": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "bookmark" }, "name": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "entityType", "name" ] }, "BlockNavigationAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeId": { "type": "string" }, "nodeType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, "AffectedRefRemapping": { "type": "object", "properties": { "from": { "$ref": "#/$defs/AffectedRef" }, "to": { "$ref": "#/$defs/AffectedRef" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "TextRangeShift": { "type": "object", "properties": { "story": { "$ref": "#/$defs/StoryLocator" }, "atChar": { "type": "integer" }, "delta": { "type": "integer" } }, "additionalProperties": false, "required": [ "story", "atChar", "delta" ] } }, "oneOf": [ { "$ref": "#/$defs/ReceiptSuccess" }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "enum": [ "INVALID_INPUT", "INVALID_TARGET", "INVALID_PAYLOAD", "EMPTY_FRAGMENT", "INVALID_FRAGMENT", "CAPABILITY_UNSUPPORTED", "CAPABILITY_UNAVAILABLE", "REVISION_MISMATCH", "PRECONDITION_FAILED" ] }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_INPUT` - `INVALID_TARGET` - `INVALID_PAYLOAD` - `EMPTY_FRAGMENT` - `INVALID_FRAGMENT` - `CAPABILITY_UNSUPPORTED` - `CAPABILITY_UNAVAILABLE` - `REVISION_MISMATCH` - `PRECONDITION_FAILED` ## clipboard.serializeSelection - Member path: `doc.clipboard.serializeSelection(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ClipboardSerializeResult containing the payload and normalized insert plan. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object" }, "includeHtml": { "type": "boolean" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "payload": { "type": "object" }, "plan": { "type": "object" }, "warnings": { "type": "array" } }, "additionalProperties": false, "required": [ "payload", "plan" ] } ``` ### Pre-apply throws - None ### Non-applied receipt codes - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` # Cross-References operations Cross-reference field inspection, insertion, rebuild, and removal. ## crossRefs.list - Member path: `doc.crossRefs.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CrossRefsListResult containing discovered cross-references with address and domain data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## crossRefs.get - Member path: `doc.crossRefs.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CrossRefInfo object with the cross-reference's target, display, and resolved text. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "crossRef" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## crossRefs.insert - Member path: `doc.crossRefs.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CrossRefMutationResult indicating success with the cross-reference address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "at": { "$ref": "#/$defs/TextTarget" }, "target": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "bookmark" }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "name" ] }, { "type": "object", "properties": { "kind": { "const": "heading" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "note" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "caption" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "numberedItem" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeId" ] }, { "type": "object", "properties": { "kind": { "const": "styledParagraph" }, "styleName": { "type": "string" }, "direction": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "styleName" ] } ] }, "display": { "enum": [ "content", "pageNumber", "noteNumber", "labelAndNumber", "aboveBelow", "numberOnly", "numberFullContext", "styledContent", "styledPageNumber" ] } }, "additionalProperties": false, "required": [ "at", "target", "display" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "crossRef": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "crossRef" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "crossRef" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## crossRefs.rebuild - Member path: `doc.crossRefs.rebuild(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CrossRefMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "crossRef" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "crossRef": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "crossRef" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "crossRef" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## crossRefs.remove - Member path: `doc.crossRefs.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CrossRefMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "crossRef" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "crossRef": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "crossRef" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "crossRef" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Index operations Index (TABLE OF AUTHORITIES / INDEX field) lifecycle and XE entry operations. ## index.list - Member path: `doc.index.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an IndexListResult containing discovered index blocks with address and domain data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## index.get - Member path: `doc.index.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an IndexInfo object with the index's instruction, configuration, and entry count. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "index" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## index.insert - Member path: `doc.index.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an IndexMutationResult indicating success with the index address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "at": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] } ] }, "config": { "type": "object", "properties": { "headingSeparator": { "type": "string" }, "entryPageSeparator": { "type": "string" }, "pageRangeSeparator": { "type": "string" }, "sequenceId": { "type": "string" }, "columns": { "type": "integer" }, "entryTypeFilter": { "type": "string" }, "pageRangeBookmark": { "type": "string" }, "letterRange": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "runIn": { "type": "boolean" }, "accentedSorting": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "at" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "index": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "index" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "index" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## index.configure - Member path: `doc.index.configure(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an IndexMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "index" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "patch": { "type": "object", "properties": { "headingSeparator": { "type": "string" }, "entryPageSeparator": { "type": "string" }, "pageRangeSeparator": { "type": "string" }, "sequenceId": { "type": "string" }, "columns": { "type": "integer" }, "entryTypeFilter": { "type": "string" }, "pageRangeBookmark": { "type": "string" }, "letterRange": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "additionalProperties": false, "required": [ "from", "to" ] }, "runIn": { "type": "boolean" }, "accentedSorting": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "target", "patch" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "index": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "index" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "index" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## index.rebuild - Member path: `doc.index.rebuild(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an IndexMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "index" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "index": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "index" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "index" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## index.remove - Member path: `doc.index.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an IndexMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "index" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "index": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "index" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "index" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## index.entries.list - Member path: `doc.index.entries.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an IndexEntryListResult containing discovered index entries with address and domain data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "entryType": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## index.entries.get - Member path: `doc.index.entries.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an IndexEntryInfo object with the entry's text, sub-entry, formatting, and instruction. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "indexEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## index.entries.insert - Member path: `doc.index.entries.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an IndexEntryMutationResult indicating success with the entry address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "at": { "$ref": "#/$defs/TextTarget" }, "entry": { "type": "object", "properties": { "text": { "type": "string" }, "subEntry": { "type": "string" }, "bold": { "type": "boolean" }, "italic": { "type": "boolean" }, "crossReference": { "type": "string" }, "pageRangeBookmark": { "type": "string" }, "entryType": { "type": "string" }, "yomi": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] } }, "additionalProperties": false, "required": [ "at", "entry" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "entry": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "indexEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "entry" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## index.entries.update - Member path: `doc.index.entries.update(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an IndexEntryMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "indexEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "patch": { "type": "object", "properties": { "text": { "type": "string" }, "subEntry": { "type": "string" }, "bold": { "type": "boolean" }, "italic": { "type": "boolean" }, "crossReference": { "type": "string" }, "pageRangeBookmark": { "type": "string" }, "entryType": { "type": "string" }, "yomi": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "target", "patch" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "entry": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "indexEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "entry" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## index.entries.remove - Member path: `doc.index.entries.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an IndexEntryMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "indexEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "entry": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "indexEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "entry" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Captions operations Caption (SEQ field) inspection, insertion, update, removal, and numbering configuration. ## captions.list - Member path: `doc.captions.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CaptionsListResult containing discovered captions with address and domain data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "label": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## captions.get - Member path: `doc.captions.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CaptionInfo object with the caption's label, number, text, and instruction. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## captions.insert - Member path: `doc.captions.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CaptionMutationResult indicating success with the caption address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "adjacentTo": { "$ref": "#/$defs/BlockNodeAddress" }, "position": { "enum": [ "above", "below" ] }, "label": { "type": "string" }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "adjacentTo", "position", "label" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "caption": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "caption" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## captions.update - Member path: `doc.captions.update(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CaptionMutationResult indicating success after appending patch.text to the existing caption body, or NO_OP when no text patch is provided. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "patch": { "type": "object", "properties": { "text": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "target", "patch" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "caption": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "caption" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## captions.remove - Member path: `doc.captions.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CaptionMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "caption": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "paragraph" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "caption" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## captions.configure - Member path: `doc.captions.configure(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CaptionConfigResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "label": { "type": "string" }, "format": { "enum": [ "decimal", "lowerRoman", "upperRoman", "lowerLetter", "upperLetter" ] }, "includeChapter": { "type": "boolean" }, "chapterStyle": { "type": "string" } }, "additionalProperties": false, "required": [ "label" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true } }, "additionalProperties": false, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Fields operations Raw field code inspection, insertion, rebuild, and removal. ## fields.list - Member path: `doc.fields.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a FieldsListResult containing discovered fields with address and domain data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## fields.get - Member path: `doc.fields.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a FieldInfo object with the field's instruction, result text, and nesting data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "field" }, "blockId": { "type": "string" }, "occurrenceIndex": { "type": "integer" }, "nestingDepth": { "type": "integer" }, "storyId": { "type": "string" }, "fieldId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "blockId", "occurrenceIndex" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## fields.insert - Member path: `doc.fields.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a FieldMutationResult indicating success with the field address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "mode": { "const": "raw" }, "at": { "$ref": "#/$defs/TextTarget" }, "instruction": { "type": "string" }, "cachedResultText": { "type": "string" }, "updatePolicy": { "enum": [ "rebuild", "preserveCached" ] } }, "additionalProperties": false, "required": [ "mode", "at", "instruction" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "field": { "type": "object", "properties": { "kind": { "const": "field" }, "blockId": { "type": "string" }, "occurrenceIndex": { "type": "integer" }, "nestingDepth": { "type": "integer" }, "storyId": { "type": "string" }, "fieldId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "blockId", "occurrenceIndex" ] } }, "additionalProperties": false, "required": [ "success", "field" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## fields.rebuild - Member path: `doc.fields.rebuild(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a FieldMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "field" }, "blockId": { "type": "string" }, "occurrenceIndex": { "type": "integer" }, "nestingDepth": { "type": "integer" }, "storyId": { "type": "string" }, "fieldId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "blockId", "occurrenceIndex" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "field": { "type": "object", "properties": { "kind": { "const": "field" }, "blockId": { "type": "string" }, "occurrenceIndex": { "type": "integer" }, "nestingDepth": { "type": "integer" }, "storyId": { "type": "string" }, "fieldId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "blockId", "occurrenceIndex" ] } }, "additionalProperties": false, "required": [ "success", "field" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## fields.remove - Member path: `doc.fields.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a FieldMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "mode": { "const": "raw" }, "target": { "type": "object", "properties": { "kind": { "const": "field" }, "blockId": { "type": "string" }, "occurrenceIndex": { "type": "integer" }, "nestingDepth": { "type": "integer" }, "storyId": { "type": "string" }, "fieldId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "blockId", "occurrenceIndex" ] } }, "additionalProperties": false, "required": [ "mode", "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "field": { "type": "object", "properties": { "kind": { "const": "field" }, "blockId": { "type": "string" }, "occurrenceIndex": { "type": "integer" }, "nestingDepth": { "type": "integer" }, "storyId": { "type": "string" }, "fieldId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "blockId", "occurrenceIndex" ] } }, "additionalProperties": false, "required": [ "success", "field" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Citations operations Citation, source, and bibliography lifecycle operations. ## citations.list - Member path: `doc.citations.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CitationsListResult containing discovered citation marks with address and domain data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## citations.get - Member path: `doc.citations.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CitationInfo object with the citation's source references and display text. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "citation" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.insert - Member path: `doc.citations.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CitationMutationResult indicating success with the citation address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "at": { "$ref": "#/$defs/TextTarget" }, "sourceIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "at", "sourceIds" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "citation": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "citation" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "citation" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.update - Member path: `doc.citations.update(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CitationMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "citation" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "patch": { "type": "object", "properties": { "sourceIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "target", "patch" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "citation": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "citation" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "citation" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.remove - Member path: `doc.citations.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CitationMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "citation" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "citation": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "citation" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "citation" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.sources.list - Member path: `doc.citations.sources.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CitationSourcesListResult containing discovered sources with address and domain data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "type": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## citations.sources.get - Member path: `doc.citations.sources.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CitationSourceInfo object with the source's type, fields, and metadata. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "citationSource" }, "sourceId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "sourceId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.sources.insert - Member path: `doc.citations.sources.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CitationSourceMutationResult indicating success with the source address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "type": { "enum": [ "book", "journalArticle", "conferenceProceedings", "report", "website", "patent", "case", "statute", "thesis", "film", "interview", "misc" ] }, "fields": { "type": "object", "properties": { "title": { "type": "string" }, "authors": { "type": "array", "items": { "type": "object", "properties": { "first": { "type": "string" }, "middle": { "type": "string" }, "last": { "type": "string" } }, "additionalProperties": false, "required": [ "last" ] } }, "year": { "type": "string" }, "publisher": { "type": "string" }, "city": { "type": "string" }, "journalName": { "type": "string" }, "volume": { "type": "string" }, "issue": { "type": "string" }, "pages": { "type": "string" }, "url": { "type": "string" }, "doi": { "type": "string" }, "edition": { "type": "string" }, "editor": { "type": "array", "items": { "type": "object", "properties": { "first": { "type": "string" }, "middle": { "type": "string" }, "last": { "type": "string" } }, "additionalProperties": false, "required": [ "last" ] } }, "translator": { "type": "array", "items": { "type": "object", "properties": { "first": { "type": "string" }, "middle": { "type": "string" }, "last": { "type": "string" } }, "additionalProperties": false, "required": [ "last" ] } }, "medium": { "type": "string" }, "shortTitle": { "type": "string" }, "standardNumber": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "type", "fields" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "source": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "citationSource" }, "sourceId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "sourceId" ] } }, "additionalProperties": false, "required": [ "success", "source" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.sources.update - Member path: `doc.citations.sources.update(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CitationSourceMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "citationSource" }, "sourceId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "sourceId" ] }, "patch": { "type": "object", "properties": { "title": { "type": "string" }, "authors": { "type": "array", "items": { "type": "object", "properties": { "first": { "type": "string" }, "middle": { "type": "string" }, "last": { "type": "string" } }, "additionalProperties": false, "required": [ "last" ] } }, "year": { "type": "string" }, "publisher": { "type": "string" }, "city": { "type": "string" }, "journalName": { "type": "string" }, "volume": { "type": "string" }, "issue": { "type": "string" }, "pages": { "type": "string" }, "url": { "type": "string" }, "doi": { "type": "string" }, "edition": { "type": "string" }, "editor": { "type": "array", "items": { "type": "object", "properties": { "first": { "type": "string" }, "middle": { "type": "string" }, "last": { "type": "string" } }, "additionalProperties": false, "required": [ "last" ] } }, "translator": { "type": "array", "items": { "type": "object", "properties": { "first": { "type": "string" }, "middle": { "type": "string" }, "last": { "type": "string" } }, "additionalProperties": false, "required": [ "last" ] } }, "medium": { "type": "string" }, "shortTitle": { "type": "string" }, "standardNumber": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "target", "patch" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "source": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "citationSource" }, "sourceId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "sourceId" ] } }, "additionalProperties": false, "required": [ "success", "source" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.sources.remove - Member path: `doc.citations.sources.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CitationSourceMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "citationSource" }, "sourceId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "sourceId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "source": { "type": "object", "properties": { "kind": { "const": "entity" }, "entityType": { "const": "citationSource" }, "sourceId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "entityType", "sourceId" ] } }, "additionalProperties": false, "required": [ "success", "source" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.bibliography.get - Member path: `doc.citations.bibliography.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a BibliographyInfo object with the bibliography's address and configuration. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "bibliography" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.bibliography.insert - Member path: `doc.citations.bibliography.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a BibliographyMutationResult indicating success with the bibliography address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "at": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] } ] }, "style": { "type": "string" } }, "additionalProperties": false, "required": [ "at" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "bibliography": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "bibliography" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "bibliography" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.bibliography.rebuild - Member path: `doc.citations.bibliography.rebuild(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a BibliographyMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "bibliography" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "bibliography": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "bibliography" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "bibliography" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.bibliography.configure - Member path: `doc.citations.bibliography.configure(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a BibliographyMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "bibliography" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "style": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "style" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "bibliography": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "bibliography" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "bibliography" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## citations.bibliography.remove - Member path: `doc.citations.bibliography.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a BibliographyMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "bibliography" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "bibliography": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "bibliography" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "bibliography" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Table of Authorities operations Table of authorities lifecycle and TA entry operations. ## authorities.list - Member path: `doc.authorities.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an AuthoritiesListResult containing discovered TOA blocks with address and domain data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## authorities.get - Member path: `doc.authorities.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an AuthoritiesInfo object with the TOA's category filter and configuration. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfAuthorities" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## authorities.insert - Member path: `doc.authorities.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an AuthoritiesMutationResult indicating success with the TOA address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "BlockNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "at": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "documentStart" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "documentEnd" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "before" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] }, { "type": "object", "properties": { "kind": { "const": "after" }, "target": { "$ref": "#/$defs/BlockNodeAddress" } }, "additionalProperties": false, "required": [ "kind", "target" ] } ] }, "config": { "type": "object", "properties": { "category": { "type": "integer" }, "entryPageSeparator": { "type": "string" }, "usePassim": { "type": "boolean" }, "includeHeadings": { "type": "boolean" }, "tabLeader": { "type": "string" }, "pageRangeSeparator": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "at" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "authorities": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfAuthorities" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "authorities" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## authorities.configure - Member path: `doc.authorities.configure(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an AuthoritiesMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfAuthorities" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "patch": { "type": "object", "properties": { "category": { "type": "integer" }, "entryPageSeparator": { "type": "string" }, "usePassim": { "type": "boolean" }, "includeHeadings": { "type": "boolean" }, "tabLeader": { "type": "string" }, "pageRangeSeparator": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "target", "patch" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "authorities": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfAuthorities" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "authorities" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## authorities.rebuild - Member path: `doc.authorities.rebuild(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an AuthoritiesMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfAuthorities" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "authorities": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfAuthorities" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "authorities" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## authorities.remove - Member path: `doc.authorities.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an AuthoritiesMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfAuthorities" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "authorities": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "const": "tableOfAuthorities" }, "nodeId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "additionalProperties": false, "required": [ "success", "authorities" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## authorities.entries.list - Member path: `doc.authorities.entries.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an AuthorityEntryListResult containing discovered entries with address and domain data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "category": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## authorities.entries.get - Member path: `doc.authorities.entries.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an AuthorityEntryInfo object with the entry's citations and category. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "authorityEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## authorities.entries.insert - Member path: `doc.authorities.entries.insert(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an AuthorityEntryMutationResult indicating success with the entry address or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] } }, "type": "object", "properties": { "at": { "$ref": "#/$defs/TextTarget" }, "entry": { "type": "object", "properties": { "longCitation": { "type": "string" }, "shortCitation": { "type": "string" }, "category": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "bold": { "type": "boolean" }, "italic": { "type": "boolean" } }, "additionalProperties": false, "required": [ "longCitation", "category" ] } }, "additionalProperties": false, "required": [ "at", "entry" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "entry": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "authorityEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "entry" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## authorities.entries.update - Member path: `doc.authorities.entries.update(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an AuthorityEntryMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "authorityEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] }, "patch": { "type": "object", "properties": { "longCitation": { "type": "string" }, "shortCitation": { "type": "string" }, "category": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "bold": { "type": "boolean" }, "italic": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "target", "patch" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "entry": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "authorityEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "entry" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## authorities.entries.remove - Member path: `doc.authorities.entries.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an AuthorityEntryMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "type": "object", "properties": { "target": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "authorityEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "InlineAnchor": { "type": "object", "properties": { "start": { "$ref": "#/$defs/Position" }, "end": { "$ref": "#/$defs/Position" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "Position": { "type": "object", "properties": { "blockId": { "type": "string" }, "offset": { "type": "integer" } }, "additionalProperties": false, "required": [ "blockId", "offset" ] } }, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "entry": { "type": "object", "properties": { "kind": { "const": "inline" }, "nodeType": { "const": "authorityEntry" }, "anchor": { "$ref": "#/$defs/InlineAnchor" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "anchor" ] } }, "additionalProperties": false, "required": [ "success", "entry" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Ranges operations Deterministic range construction from explicit document anchors. ## ranges.resolve - Member path: `doc.ranges.resolve(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a ResolveRangeOutput with evaluatedRevision, handle.ref may be null, handle.coversFullTarget, target (SelectionTarget), and preview metadata. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] } }, "type": "object", "properties": { "start": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "document" }, "edge": { "enum": [ "start", "end" ] } }, "additionalProperties": false, "required": [ "kind", "edge" ] }, { "type": "object", "properties": { "kind": { "const": "point" }, "point": { "$ref": "#/$defs/SelectionPoint" } }, "additionalProperties": false, "required": [ "kind", "point" ] }, { "type": "object", "properties": { "kind": { "const": "ref" }, "ref": { "type": "string", "minLength": 1 }, "boundary": { "enum": [ "start", "end" ] } }, "additionalProperties": false, "required": [ "kind", "ref", "boundary" ] } ] }, "end": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "document" }, "edge": { "enum": [ "start", "end" ] } }, "additionalProperties": false, "required": [ "kind", "edge" ] }, { "type": "object", "properties": { "kind": { "const": "point" }, "point": { "$ref": "#/$defs/SelectionPoint" } }, "additionalProperties": false, "required": [ "kind", "point" ] }, { "type": "object", "properties": { "kind": { "const": "ref" }, "ref": { "type": "string", "minLength": 1 }, "boundary": { "enum": [ "start", "end" ] } }, "additionalProperties": false, "required": [ "kind", "ref", "boundary" ] } ] }, "in": { "$ref": "#/$defs/StoryLocator" }, "expectedRevision": { "type": "string" } }, "additionalProperties": false, "required": [ "start", "end" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "evaluatedRevision": { "type": "string" }, "handle": { "type": "object", "properties": { "ref": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "refStability": { "const": "ephemeral" }, "coversFullTarget": { "type": "boolean" } }, "additionalProperties": false, "required": [ "ref", "refStability", "coversFullTarget" ] }, "target": { "$ref": "#/$defs/SelectionTarget" }, "preview": { "type": "object", "properties": { "text": { "type": "string" }, "truncated": { "type": "boolean" }, "blocks": { "type": "array", "items": { "type": "object", "properties": { "nodeId": { "type": "string" }, "nodeType": { "enum": [ "paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt" ] }, "textPreview": { "type": "string" } }, "additionalProperties": false, "required": [ "nodeId", "nodeType", "textPreview" ] } } }, "additionalProperties": false, "required": [ "text", "truncated", "blocks" ] } }, "additionalProperties": false, "required": [ "evaluatedRevision", "handle", "target", "preview" ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `INVALID_TARGET` - `TARGET_NOT_FOUND` - `INVALID_CONTEXT` - `REVISION_MISMATCH` - `AMBIGUOUS_MATCH` - `ADDRESS_STALE` - `STORY_MISMATCH` ### Non-applied receipt codes - None # Selection operations Read the editor's current selection as a portable, addressable target. ## selection.current - Member path: `doc.selection.current(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a SelectionInfo with `empty`, `target` (TextTarget or null), optional `selectionTarget`, `activeMarks`, and optionally `text` when `includeText: true`. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "includeText": { "type": "boolean" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "TextTarget": { "type": "object", "properties": { "kind": { "const": "text" }, "segments": { "type": "array", "items": { "$ref": "#/$defs/TextSegment" }, "minItems": 1 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "segments" ] }, "TextSegment": { "type": "object", "properties": { "blockId": { "type": "string" }, "range": { "$ref": "#/$defs/Range" } }, "additionalProperties": false, "required": [ "blockId", "range" ] }, "Range": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "start", "end" ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "empty": { "type": "boolean" }, "target": { "oneOf": [ { "$ref": "#/$defs/TextTarget" }, { "type": "null" } ] }, "selectionTarget": { "oneOf": [ { "$ref": "#/$defs/SelectionTarget" }, { "type": "null" } ] }, "activeMarks": { "type": "array", "items": { "type": "string" } }, "activeCommentIds": { "type": "array", "items": { "type": "string" } }, "activeChangeIds": { "type": "array", "items": { "type": "string" } }, "text": { "type": "string" } }, "additionalProperties": false, "required": [ "empty", "target", "activeMarks", "activeCommentIds", "activeChangeIds" ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `INVALID_CONTEXT` ### Non-applied receipt codes - None # Diff operations Snapshot-based document comparison and replay. ## diff.capture - Member path: `doc.diff.capture(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a DiffSnapshot with a fingerprint and opaque payload. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "version": { "type": "string", "enum": [ "sd-diff-snapshot/v1", "sd-diff-snapshot/v2" ] }, "engine": { "type": "string", "enum": [ "superdoc-v2" ] }, "fingerprint": { "type": "string" }, "coverage": { "type": "object", "properties": { "body": { "type": "boolean", "const": true }, "comments": { "type": "boolean" }, "styles": { "type": "boolean" }, "numbering": { "type": "boolean" }, "headerFooters": { "type": "boolean" } }, "additionalProperties": false, "required": [ "body", "comments", "styles", "numbering", "headerFooters" ] }, "payload": { "type": "object", "description": "Opaque engine-owned snapshot data." } }, "additionalProperties": false, "required": [ "version", "engine", "fingerprint", "coverage", "payload" ] } ``` ### Pre-apply throws - `PRECONDITION_FAILED` ### Non-applied receipt codes - None ## diff.compare - Member path: `doc.diff.compare(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a DiffPayload with a summary and opaque payload. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "targetSnapshot": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "sd-diff-snapshot/v1", "sd-diff-snapshot/v2" ] }, "engine": { "type": "string", "enum": [ "superdoc-v2" ] }, "fingerprint": { "type": "string" }, "coverage": { "type": "object", "properties": { "body": { "type": "boolean", "const": true }, "comments": { "type": "boolean" }, "styles": { "type": "boolean" }, "numbering": { "type": "boolean" }, "headerFooters": { "type": "boolean" } }, "additionalProperties": false, "required": [ "body", "comments", "styles", "numbering", "headerFooters" ] }, "payload": { "type": "object", "description": "Opaque engine-owned snapshot data." } }, "additionalProperties": false, "required": [ "version", "engine", "fingerprint", "coverage", "payload" ] } }, "additionalProperties": false, "required": [ "targetSnapshot" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "version": { "type": "string", "enum": [ "sd-diff-payload/v1", "sd-diff-payload/v2" ] }, "engine": { "type": "string", "enum": [ "superdoc-v2" ] }, "baseFingerprint": { "type": "string" }, "targetFingerprint": { "type": "string" }, "coverage": { "type": "object", "properties": { "body": { "type": "boolean", "const": true }, "comments": { "type": "boolean" }, "styles": { "type": "boolean" }, "numbering": { "type": "boolean" }, "headerFooters": { "type": "boolean" } }, "additionalProperties": false, "required": [ "body", "comments", "styles", "numbering", "headerFooters" ] }, "summary": { "type": "object", "properties": { "hasChanges": { "type": "boolean" }, "changedComponents": { "type": "array", "items": { "type": "string", "enum": [ "body", "comments", "styles", "numbering", "headerFooters", "parts" ] } }, "body": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "comments": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "styles": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "numbering": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "headerFooters": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "parts": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] } }, "additionalProperties": false, "required": [ "hasChanges", "changedComponents", "body", "comments", "styles", "numbering", "headerFooters", "parts" ] }, "payload": { "type": "object", "description": "Opaque engine-owned diff data." } }, "additionalProperties": false, "required": [ "version", "engine", "baseFingerprint", "targetFingerprint", "coverage", "summary", "payload" ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `CAPABILITY_UNSUPPORTED` ### Non-applied receipt codes - None ## diff.apply - Member path: `doc.diff.apply(…)` - Mutates document: yes - Idempotency: `conditional` - Supports tracked mode: yes - Supports dry run: no ### Expected result Returns a DiffApplyResult with applied operation count and diagnostics. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "diff": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "sd-diff-payload/v1", "sd-diff-payload/v2" ] }, "engine": { "type": "string", "enum": [ "superdoc-v2" ] }, "baseFingerprint": { "type": "string" }, "targetFingerprint": { "type": "string" }, "coverage": { "type": "object", "properties": { "body": { "type": "boolean", "const": true }, "comments": { "type": "boolean" }, "styles": { "type": "boolean" }, "numbering": { "type": "boolean" }, "headerFooters": { "type": "boolean" } }, "additionalProperties": false, "required": [ "body", "comments", "styles", "numbering", "headerFooters" ] }, "summary": { "type": "object", "properties": { "hasChanges": { "type": "boolean" }, "changedComponents": { "type": "array", "items": { "type": "string", "enum": [ "body", "comments", "styles", "numbering", "headerFooters", "parts" ] } }, "body": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "comments": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "styles": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "numbering": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "headerFooters": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "parts": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] } }, "additionalProperties": false, "required": [ "hasChanges", "changedComponents", "body", "comments", "styles", "numbering", "headerFooters", "parts" ] }, "payload": { "type": "object", "description": "Opaque engine-owned diff data." } }, "additionalProperties": false, "required": [ "version", "engine", "baseFingerprint", "targetFingerprint", "coverage", "summary", "payload" ] } }, "additionalProperties": false, "required": [ "diff" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "appliedOperations": { "type": "integer" }, "baseFingerprint": { "type": "string" }, "targetFingerprint": { "type": "string" }, "coverage": { "type": "object", "properties": { "body": { "type": "boolean", "const": true }, "comments": { "type": "boolean" }, "styles": { "type": "boolean" }, "numbering": { "type": "boolean" }, "headerFooters": { "type": "boolean" } }, "additionalProperties": false, "required": [ "body", "comments", "styles", "numbering", "headerFooters" ] }, "summary": { "type": "object", "properties": { "hasChanges": { "type": "boolean" }, "changedComponents": { "type": "array", "items": { "type": "string", "enum": [ "body", "comments", "styles", "numbering", "headerFooters", "parts" ] } }, "body": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "comments": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "styles": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "numbering": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "headerFooters": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] }, "parts": { "type": "object", "properties": { "hasChanges": { "type": "boolean" } }, "additionalProperties": false, "required": [ "hasChanges" ] } }, "additionalProperties": false, "required": [ "hasChanges", "changedComponents", "body", "comments", "styles", "numbering", "headerFooters", "parts" ] }, "diagnostics": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "appliedOperations", "baseFingerprint", "targetFingerprint", "coverage", "summary", "diagnostics" ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `CAPABILITY_UNSUPPORTED` - `PRECONDITION_FAILED` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Export operations Modeful DOCX export (review-preserving / final / original) with a structured degradation report. ## export.toDocx - Member path: `doc.export.toDocx(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an ExportToDocxResult with the resolved mode, base64 DOCX bytes, byte length, and a report.warnings array. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "mode": { "enum": [ "review-preserving", "final", "original" ] } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "mode": { "enum": [ "review-preserving", "final", "original" ] }, "byteLength": { "type": "integer" }, "contentBase64": { "type": "string" }, "report": { "type": "object", "properties": { "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "feature": { "type": "string", "enum": [ "comments", "trackedChanges" ] }, "severity": { "const": "warning" }, "affectedObjectId": { "type": "string" }, "affectedPartUri": { "type": "string" }, "canProceed": { "type": "boolean" } }, "additionalProperties": false, "required": [ "code", "message", "feature", "severity", "canProceed" ] } } }, "additionalProperties": false, "required": [ "warnings" ] } }, "additionalProperties": false, "required": [ "mode", "byteLength", "contentBase64", "report" ] } ``` ### Pre-apply throws - `INVALID_INPUT` - `CAPABILITY_UNSUPPORTED` ### Non-applied receipt codes - None # Protection operations Document-level protection state and editing restriction operations. ## protection.get - Member path: `doc.protection.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a DocumentProtectionState with editingRestriction, writeProtection, and readOnlyRecommended fields. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "editingRestriction": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "none", "readOnly", "comments", "trackedChanges", "forms" ] }, "enforced": { "type": "boolean" }, "runtimeEnforced": { "type": "boolean" }, "passwordProtected": { "type": "boolean" }, "formattingRestricted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "mode", "enforced", "runtimeEnforced", "passwordProtected", "formattingRestricted" ] }, "writeProtection": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "passwordProtected": { "type": "boolean" } }, "additionalProperties": false, "required": [ "enabled", "passwordProtected" ] }, "readOnlyRecommended": { "type": "boolean" } }, "additionalProperties": false, "required": [ "editingRestriction", "writeProtection", "readOnlyRecommended" ] } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## protection.setEditingRestriction - Member path: `doc.protection.setEditingRestriction(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ProtectionMutationResult with the updated protection state on success. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "mode": { "type": "string", "enum": [ "readOnly" ] }, "formattingRestricted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "mode" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` ## protection.clearEditingRestriction - Member path: `doc.protection.clearEditingRestriction(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a ProtectionMutationResult with the updated protection state on success. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": {}, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `NO_OP` # Permission Ranges operations Permission range exception operations for protected documents. ## permissionRanges.list - Member path: `doc.permissionRanges.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a PermissionRangesListResult containing discovered permission ranges with principal and position data. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## permissionRanges.get - Member path: `doc.permissionRanges.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a PermissionRangeInfo object with the range principal, kind, and positions. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## permissionRanges.create - Member path: `doc.permissionRanges.create(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a PermissionRangeMutationResult with the created range info on success. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget" }, "principal": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "everyone", "editor" ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "kind" ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "target", "principal" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## permissionRanges.remove - Member path: `doc.permissionRanges.remove(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a PermissionRangeRemoveResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## permissionRanges.updatePrincipal - Member path: `doc.permissionRanges.updatePrincipal(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a PermissionRangeMutationResult with the updated range info on success. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "id": { "type": "string" }, "principal": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "everyone", "editor" ] }, "id": { "type": "string" } }, "additionalProperties": false, "required": [ "kind" ] } }, "additionalProperties": false, "required": [ "id", "principal" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None # Custom XML operations Custom XML Data Storage Part operations (ECMA-376 §15.2.5, §15.2.6). Raw read and write of custom XML parts in the OOXML package. ## customXml.parts.list - Member path: `doc.customXml.parts.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CustomXmlPartsListResult with summary entries (no content); fetch content via get. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 }, "rootNamespace": { "type": "string" }, "schemaRef": { "type": "string" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## customXml.parts.get - Member path: `doc.customXml.parts.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns a CustomXmlPartInfo with id, partName, namespaces, schemaRefs, and content; or null if not found. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "id" ] }, { "type": "object", "properties": { "partName": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "partName" ] } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object" }, { "type": "null" } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## customXml.parts.create - Member path: `doc.customXml.parts.create(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CustomXmlPartsCreateResult with the generated id and package part names on success. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "content": { "type": "string", "minLength": 1 }, "schemaRefs": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "additionalProperties": false, "required": [ "content" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "id": { "type": "string" }, "partName": { "type": "string" }, "propsPartName": { "type": "string" } }, "additionalProperties": false, "required": [ "success", "id", "partName", "propsPartName" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `INVALID_INPUT` ## customXml.parts.patch - Member path: `doc.customXml.parts.patch(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CustomXmlPartsMutationResult indicating success with the resolved target or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "id" ] }, { "type": "object", "properties": { "partName": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "partName" ] } ] }, "content": { "type": "string", "minLength": 1 }, "schemaRefs": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "target" ], "anyOf": [ { "required": [ "content" ] }, { "required": [ "schemaRefs" ] } ], "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "id" ] }, { "type": "object", "properties": { "partName": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "partName" ] } ] }, "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "success", "target" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `TARGET_NOT_FOUND` - `INVALID_INPUT` ## customXml.parts.remove - Member path: `doc.customXml.parts.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns a CustomXmlPartsMutationResult indicating success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "target": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "id" ] }, { "type": "object", "properties": { "partName": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "partName" ] } ] } }, "additionalProperties": false, "required": [ "target" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "target": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "id" ] }, { "type": "object", "properties": { "partName": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "partName" ] } ] }, "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "success", "target" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - `TARGET_NOT_FOUND` # Anchored Metadata operations Attach a JSON payload to a span of text and read it back across DOCX round-trips. Backed by hidden inline content controls and namespaced Custom XML Data Storage Parts; consumers see one operation set. ## metadata.attach - Member path: `doc.metadata.attach(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an AnchoredMetadataAttachResult with the assigned id and the backing Storage Part name on success. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "target": { "$ref": "#/$defs/SelectionTarget" }, "namespace": { "type": "string", "minLength": 1 }, "payload": {}, "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "target", "namespace", "payload" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "id": { "type": "string", "minLength": 1 }, "namespace": { "type": "string", "minLength": 1 }, "partName": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "success", "id", "namespace", "partName" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `REVISION_MISMATCH` ### Non-applied receipt codes - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` ## metadata.list - Member path: `doc.metadata.list(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an AnchoredMetadataListResult with summary entries (no payload); fetch payload via get. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": { "SelectionTarget": { "type": "object", "properties": { "kind": { "const": "selection" }, "start": { "$ref": "#/$defs/SelectionPoint" }, "end": { "$ref": "#/$defs/SelectionPoint" }, "story": { "$ref": "#/$defs/StoryLocator" }, "coordinateSpace": { "$ref": "#/$defs/TextCoordinateSpace" } }, "additionalProperties": false, "required": [ "kind", "start", "end" ] }, "SelectionPoint": { "description": "A point in the document. Use {kind:'text', blockId, offset} for character positions or {kind:'nodeEdge', node:{kind:'block', nodeType, nodeId}, edge:'before'|'after'} for block boundaries.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "text" }, "blockId": { "type": "string" }, "offset": { "type": "integer", "minimum": 0 }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "blockId", "offset" ] }, { "type": "object", "properties": { "kind": { "const": "nodeEdge" }, "node": { "$ref": "#/$defs/SelectionEdgeNodeAddress" }, "edge": { "enum": [ "before", "after" ] } }, "additionalProperties": false, "required": [ "kind", "node", "edge" ] } ] }, "StoryLocator": { "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.", "oneOf": [ { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "body" } }, "additionalProperties": false, "required": [ "kind", "storyType" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterSlot" }, "section": { "$ref": "#/$defs/SectionAddress" }, "headerFooterKind": { "enum": [ "header", "footer" ] }, "variant": { "enum": [ "default", "first", "even" ] }, "resolution": { "enum": [ "effective", "explicit" ] }, "onWrite": { "enum": [ "materializeIfInherited", "editResolvedPart", "error" ] } }, "additionalProperties": false, "required": [ "kind", "storyType", "section", "headerFooterKind", "variant" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "headerFooterPart" }, "refId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "refId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "footnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "endnote" }, "noteId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "noteId" ] }, { "type": "object", "properties": { "kind": { "const": "story" }, "storyType": { "const": "textbox" }, "textboxId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "storyType", "textboxId" ] } ] }, "SectionAddress": { "type": "object", "properties": { "kind": { "const": "section" }, "sectionId": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "sectionId" ] }, "SelectionEdgeNodeAddress": { "type": "object", "properties": { "kind": { "const": "block" }, "nodeType": { "enum": [ "paragraph", "heading", "table", "tableOfContents", "sdt", "image" ] }, "nodeId": { "type": "string" }, "story": { "$ref": "#/$defs/StoryLocator" } }, "additionalProperties": false, "required": [ "kind", "nodeType", "nodeId" ] }, "TextCoordinateSpace": { "enum": [ "visible", "tracked" ] } }, "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 }, "namespace": { "type": "string" }, "within": { "$ref": "#/$defs/SelectionTarget" } }, "additionalProperties": false } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object" } ``` ### Pre-apply throws - `CAPABILITY_UNAVAILABLE` - `INVALID_INPUT` ### Non-applied receipt codes - None ## metadata.get - Member path: `doc.metadata.get(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an AnchoredMetadataInfo with id, namespace, partName, and payload; or null if not found. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "id" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object" }, { "type": "null" } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None ## metadata.update - Member path: `doc.metadata.update(…)` - Mutates document: yes - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an AnchoredMetadataMutationResult with the entry id on success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "payload": {} }, "additionalProperties": false, "required": [ "id", "payload" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "success", "id" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `INVALID_INPUT` - `CAPABILITY_UNAVAILABLE` - `REVISION_MISMATCH` ### Non-applied receipt codes - `TARGET_NOT_FOUND` - `INVALID_INPUT` ## metadata.remove - Member path: `doc.metadata.remove(…)` - Mutates document: yes - Idempotency: `non-idempotent` - Supports tracked mode: no - Supports dry run: yes ### Expected result Returns an AnchoredMetadataMutationResult with the removed entry id on success or a failure. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "id" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object", "properties": { "success": { "const": true }, "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "success", "id" ] }, { "type": "object", "properties": { "success": { "const": false }, "failure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "additionalProperties": false, "required": [ "code", "message" ] } }, "additionalProperties": false, "required": [ "success", "failure" ] } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `INVALID_TARGET` - `CAPABILITY_UNAVAILABLE` - `REVISION_MISMATCH` ### Non-applied receipt codes - `TARGET_NOT_FOUND` ## metadata.resolve - Member path: `doc.metadata.resolve(…)` - Mutates document: no - Idempotency: `idempotent` - Supports tracked mode: no - Supports dry run: no ### Expected result Returns an AnchoredMetadataResolveInfo with id and target SelectionTarget; or null if the anchor is no longer present. ### Input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "id" ] } ``` ### Output schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "$defs": {}, "oneOf": [ { "type": "object" }, { "type": "null" } ] } ``` ### Pre-apply throws - `TARGET_NOT_FOUND` - `CAPABILITY_UNAVAILABLE` ### Non-applied receipt codes - None