Document apiReferenceAuthorities

authorities.configure

Update the configuration of an existing table-of-authorities block.

mutates documentdry runidempotent
doc.authorities.configure(…)

Expected result

Returns an AuthoritiesMutationResult indicating success or a failure.

Inputs

targetobjectrequired
Fields
kind"block"required
nodeType"tableOfAuthorities"required
nodeIdstringrequired
patchobjectrequired
Fields
categoryinteger
entryPageSeparatorstring
usePassimboolean
includeHeadingsboolean
tabLeaderstring
pageRangeSeparatorstring

Result

Output fields
true
successtruerequired
appliedChangeMode"direct" | "tracked"
authoritiesobjectrequired
Fields
kind"block"required
nodeType"tableOfAuthorities"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