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

​
Summary

Insert a TC (table of contents entry) field at the target paragraph.
  • Operation ID: toc.markEntry
  • API member path: editor.doc.toc.markEntry(...)
  • Mutates document: yes
  • Idempotency: non-idempotent
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

​
Expected result

Returns a TocEntryMutationResult with the created entry address on success.

​
Input fields

FieldTypeRequiredDescription
levelintegerno
omitPageNumberbooleanno
tableIdentifierstringno
targetobject(kind=“inline-insert”)yes
textstringyes

​
Example request

{
  "level": 1,
  "tableIdentifier": "example",
  "target": {
    "anchor": {
      "nodeId": "node-def456",
      "nodeType": "paragraph"
    },
    "kind": "inline-insert",
    "position": "start"
  },
  "text": "Hello, world."
}

​
Output fields

No fields.

​
Example response

{
  "entry": {
    "kind": "inline",
    "nodeId": "node-def456",
    "nodeType": "tableOfContentsEntry"
  },
  "success": true
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • NO_OP
  • INVALID_INSERTION_CONTEXT

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "level": {
      "maximum": 9,
      "minimum": 1,
      "type": "integer"
    },
    "omitPageNumber": {
      "type": "boolean"
    },
    "tableIdentifier": {
      "type": "string"
    },
    "target": {
      "additionalProperties": false,
      "properties": {
        "anchor": {
          "additionalProperties": false,
          "properties": {
            "nodeId": {
              "type": "string"
            },
            "nodeType": {
              "const": "paragraph"
            }
          },
          "required": [
            "nodeType",
            "nodeId"
          ],
          "type": "object"
        },
        "kind": {
          "const": "inline-insert"
        },
        "position": {
          "enum": [
            "start",
            "end"
          ]
        }
      },
      "required": [
        "kind",
        "anchor"
      ],
      "type": "object"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "target",
    "text"
  ],
  "type": "object"
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "entry": {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "inline"
            },
            "nodeId": {
              "type": "string"
            },
            "nodeType": {
              "const": "tableOfContentsEntry"
            }
          },
          "required": [
            "kind",
            "nodeType",
            "nodeId"
          ],
          "type": "object"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "entry"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "NO_OP",
                "INVALID_TARGET",
                "TARGET_NOT_FOUND",
                "CAPABILITY_UNAVAILABLE",
                "INVALID_INSERTION_CONTEXT",
                "INVALID_INPUT"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

{
  "additionalProperties": false,
  "properties": {
    "entry": {
      "additionalProperties": false,
      "properties": {
        "kind": {
          "const": "inline"
        },
        "nodeId": {
          "type": "string"
        },
        "nodeType": {
          "const": "tableOfContentsEntry"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "nodeId"
      ],
      "type": "object"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "entry"
  ],
  "type": "object"
}

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