Document apiReferenceFields

fields.remove

Remove a field from the document.

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

Expected result

Returns a FieldMutationResult indicating success or a failure.

Inputs

mode"raw"required
targetobjectrequired
Fields
kind"field"required
blockIdstringrequired
occurrenceIndexintegerrequired
nestingDepthinteger
storyIdstring
fieldIdstring

Result

Output fields
true
successtruerequired
fieldobjectrequired
Fields
kind"field"required
blockIdstringrequired
occurrenceIndexintegerrequired
nestingDepthinteger
storyIdstring
fieldIdstring
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