Document apiReferenceDocument index

index.remove

Remove an index block from the document.

mutates documentdry runnon-idempotent
doc.index.remove(…)

Expected result

Returns an IndexMutationResult indicating success or a failure.

Inputs

targetobjectrequired
Fields
kind"block"required
nodeType"index"required
nodeIdstringrequired

Result

Output fields
true
successtruerequired
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
  • 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