Document apiReferenceCross refs

crossRefs.remove

Remove a cross-reference field from the document.

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

Expected result

Returns a CrossRefMutationResult indicating success or a failure.

Inputs

targetobjectrequired
Fields
kind"inline"required
nodeType"crossRef"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired

Result

Output fields
true
successtruerequired
crossRefobjectrequired
Fields
kind"inline"required
nodeType"crossRef"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired
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