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

​
Summary

Insert a new index block at a target location.
  • Operation ID: index.insert
  • API member path: editor.doc.index.insert(...)
  • Mutates document: yes
  • Idempotency: non-idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Expected result

Returns an IndexMutationResult indicating success with the index address or a failure.

​
Input fields

FieldTypeRequiredDescription
atobject(kind=“documentStart”) \object(kind=“documentEnd”) \object(kind=“before”) \object(kind=“after”)yesOne of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”)
configobjectno
config.accentedSortingbooleanno
config.columnsintegerno
config.entryPageSeparatorstringno
config.entryTypeFilterstringno
config.headingSeparatorstringno
config.letterRangeobjectno
config.letterRange.fromstringno
config.letterRange.tostringno
config.pageRangeBookmarkstringno
config.pageRangeSeparatorstringno
config.runInbooleanno
config.sequenceIdstringno

​
Example request

{
  "at": {
    "kind": "documentStart"
  },
  "config": {
    "entryPageSeparator": "example",
    "headingSeparator": "example"
  }
}

​
Output fields

​
Variant 1 (index.kind=“block”)

FieldTypeRequiredDescription
indexobject(kind=“block”)yes
index.kind"block"yesConstant: "block"
index.nodeIdstringyes
index.nodeType"index"yesConstant: "index"
successtrueyesConstant: true

​
Variant 2 (success=false)

FieldTypeRequiredDescription
failureobjectyes
failure.codestringyes
failure.detailsanyno
failure.messagestringyes
successfalseyesConstant: false

​
Example response

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

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "at": {
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "documentStart"
            }
          },
          "required": [
            "kind"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "documentEnd"
            }
          },
          "required": [
            "kind"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "before"
            },
            "target": {
              "$ref": "#/$defs/BlockNodeAddress"
            }
          },
          "required": [
            "kind",
            "target"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "after"
            },
            "target": {
              "$ref": "#/$defs/BlockNodeAddress"
            }
          },
          "required": [
            "kind",
            "target"
          ],
          "type": "object"
        }
      ]
    },
    "config": {
      "additionalProperties": false,
      "properties": {
        "accentedSorting": {
          "type": "boolean"
        },
        "columns": {
          "type": "integer"
        },
        "entryPageSeparator": {
          "type": "string"
        },
        "entryTypeFilter": {
          "type": "string"
        },
        "headingSeparator": {
          "type": "string"
        },
        "letterRange": {
          "additionalProperties": false,
          "properties": {
            "from": {
              "type": "string"
            },
            "to": {
              "type": "string"
            }
          },
          "required": [
            "from",
            "to"
          ],
          "type": "object"
        },
        "pageRangeBookmark": {
          "type": "string"
        },
        "pageRangeSeparator": {
          "type": "string"
        },
        "runIn": {
          "type": "boolean"
        },
        "sequenceId": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "required": [
    "at"
  ],
  "type": "object"
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "index": {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "block"
            },
            "nodeId": {
              "type": "string"
            },
            "nodeType": {
              "const": "index"
            }
          },
          "required": [
            "kind",
            "nodeType",
            "nodeId"
          ],
          "type": "object"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "index"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "type": "string"
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

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

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string"
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}