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:
yes - Deterministic target resolution:
yes
Expected result
Returns an IndexMutationResult indicating success or a failure.Input fields
| Field | Type | Required | Description |
|---|---|---|---|
patch | object | yes | |
patch.accentedSorting | boolean | no | |
patch.columns | integer | no | |
patch.entryPageSeparator | string | no | |
patch.entryTypeFilter | string | no | |
patch.headingSeparator | string | no | |
patch.letterRange | object | no | |
patch.letterRange.from | string | no | |
patch.letterRange.to | string | no | |
patch.pageRangeBookmark | string | no | |
patch.pageRangeSeparator | string | no | |
patch.runIn | boolean | no | |
patch.sequenceId | string | no | |
target | object(kind=“block”) | yes | |
target.kind | "block" | yes | Constant: "block" |
target.nodeId | string | yes | |
target.nodeType | "index" | yes | Constant: "index" |
Example request
{
"patch": {
"entryPageSeparator": "example",
"headingSeparator": "example"
},
"target": {
"kind": "block",
"nodeId": "node-def456",
"nodeType": "index"
}
}
Output fields
Variant 1 (success=true)
| Field | Type | Required | Description |
|---|---|---|---|
index | object(kind=“block”) | yes | |
index.kind | "block" | yes | Constant: "block" |
index.nodeId | string | yes | |
index.nodeType | "index" | yes | Constant: "index" |
success | true | yes | Constant: true |
Variant 2 (success=false)
| Field | Type | Required | Description |
|---|---|---|---|
failure | object | yes | |
failure.code | string | yes | |
failure.details | any | no | |
failure.message | string | yes | |
success | false | yes | Constant: false |
Example response
{
"index": {
"kind": "block",
"nodeId": "node-def456",
"nodeType": "index"
},
"success": true
}
Pre-apply throws
TARGET_NOT_FOUNDINVALID_TARGETINVALID_INPUTCAPABILITY_UNAVAILABLE
Non-applied failure codes
- None
Raw schemas
Raw input schema
Raw input schema
{
"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"
}
Raw output schema
Raw output schema
{
"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"
}
]
}
Raw success schema
Raw success schema
{
"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"
}
Raw failure schema
Raw failure schema
{
"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"
}