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

​
Summary

Update the configuration of an existing index block.
  • Operation ID: index.configure
  • API member path: editor.doc.index.configure(...)
  • Mutates document: yes
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Expected result

Returns an IndexMutationResult indicating success or a failure.

​
Input fields

FieldTypeRequiredDescription
patchobjectyes
patch.accentedSortingbooleanno
patch.columnsintegerno
patch.entryPageSeparatorstringno
patch.entryTypeFilterstringno
patch.headingSeparatorstringno
patch.letterRangeobjectno
patch.letterRange.fromstringno
patch.letterRange.tostringno
patch.pageRangeBookmarkstringno
patch.pageRangeSeparatorstringno
patch.runInbooleanno
patch.sequenceIdstringno
targetobject(kind=“block”)yes
target.kind"block"yesConstant: "block"
target.nodeIdstringyes
target.nodeType"index"yesConstant: "index"

​
Example request

{
  "patch": {
    "entryPageSeparator": "example",
    "headingSeparator": "example"
  },
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "index"
  }
}

​
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": {
    "patch": {
      "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"
    },
    "target": {
      "additionalProperties": false,
      "properties": {
        "kind": {
          "const": "block"
        },
        "nodeId": {
          "type": "string"
        },
        "nodeType": {
          "const": "index"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "nodeId"
      ],
      "type": "object"
    }
  },
  "required": [
    "target",
    "patch"
  ],
  "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"
}