toc.update

Rebuild or refresh the materialized content of a table of contents.

Alpha: Document API is currently alpha and subject to breaking changes.

Summary

Rebuild or refresh the materialized content of a table of contents.

• Operation ID: toc.update
• API member path: editor.doc.toc.update(...)
• Mutates document: yes
• Idempotency: conditional
• Supports tracked mode: no
• Supports dry run: yes
• Deterministic target resolution: 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 fields

Field	Type	Required	Description
mode	enum	no	"all", "pageNumbers"
target	object(kind=“block”)	yes
target.kind	"block"	yes	Constant: "block"
target.nodeId	string	yes
target.nodeType	"tableOfContents"	yes	Constant: "tableOfContents"

Example request

{
  "mode": "all",
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "tableOfContents"
  }
}

Output fields

Variant 1 (toc.kind=“block”)

Field	Type	Required	Description
success	true	yes	Constant: true
toc	object(kind=“block”)	yes
toc.kind	"block"	yes	Constant: "block"
toc.nodeId	string	yes
toc.nodeType	"tableOfContents"	yes	Constant: "tableOfContents"

Variant 2 (success=false)

Field	Type	Required	Description
failure	object	yes
failure.code	enum	yes	"NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE", "INVALID_INSERTION_CONTEXT", "PAGE_NUMBERS_NOT_MATERIALIZED"
failure.details	any	no
failure.message	string	yes
success	false	yes	Constant: false

Example response

{
  "success": true,
  "toc": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "tableOfContents"
  }
}

Pre-apply throws

• TARGET_NOT_FOUND
• INVALID_TARGET
• CAPABILITY_UNAVAILABLE

Non-applied failure codes

• NO_OP
• PAGE_NUMBERS_NOT_MATERIALIZED
• CAPABILITY_UNAVAILABLE

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "mode": {
      "enum": [
        "all",
        "pageNumbers"
      ]
    },
    "target": {
      "additionalProperties": false,
      "properties": {
        "kind": {
          "const": "block"
        },
        "nodeId": {
          "type": "string"
        },
        "nodeType": {
          "const": "tableOfContents"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "nodeId"
      ],
      "type": "object"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "const": true
        },
        "toc": {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "block"
            },
            "nodeId": {
              "type": "string"
            },
            "nodeType": {
              "const": "tableOfContents"
            }
          },
          "required": [
            "kind",
            "nodeType",
            "nodeId"
          ],
          "type": "object"
        }
      },
      "required": [
        "success",
        "toc"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "NO_OP",
                "INVALID_TARGET",
                "TARGET_NOT_FOUND",
                "CAPABILITY_UNAVAILABLE",
                "INVALID_INSERTION_CONTEXT",
                "PAGE_NUMBERS_NOT_MATERIALIZED"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "const": true
    },
    "toc": {
      "additionalProperties": false,
      "properties": {
        "kind": {
          "const": "block"
        },
        "nodeId": {
          "type": "string"
        },
        "nodeType": {
          "const": "tableOfContents"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "nodeId"
      ],
      "type": "object"
    }
  },
  "required": [
    "success",
    "toc"
  ],
  "type": "object"
}

Raw failure schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "NO_OP",
            "INVALID_TARGET",
            "TARGET_NOT_FOUND",
            "CAPABILITY_UNAVAILABLE",
            "INVALID_INSERTION_CONTEXT",
            "PAGE_NUMBERS_NOT_MATERIALIZED"
          ]
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}