Document apiReferenceDocument index

index.configure

Update the configuration of an existing index block.

mutates documentdry runidempotent
doc.index.configure(…)

Expected result

Returns an IndexMutationResult indicating success or a failure.

Inputs

targetobjectrequired
Fields
kind"block"required
nodeType"index"required
nodeIdstringrequired
patchobjectrequired
Fields
headingSeparatorstring
entryPageSeparatorstring
pageRangeSeparatorstring
sequenceIdstring
columnsinteger
entryTypeFilterstring
pageRangeBookmarkstring
letterRangeobject
Fields
fromstringrequired
tostringrequired
runInboolean
accentedSortingboolean

Result

Output fields
true
successtruerequired
appliedChangeMode"direct" | "tracked"
indexobjectrequired
Fields
kind"block"required
nodeType"index"required
nodeIdstringrequired
false
successfalserequired
failureobjectrequired
Fields
codestringrequired
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
1 more codes
  • CAPABILITY_UNAVAILABLE

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas