Document apiReferenceCaptions

captions.configure

Configure numbering format for a caption label.

mutates documentdry runidempotent
doc.captions.configure(…)

Expected result

Returns a CaptionConfigResult indicating success or a failure.

Inputs

labelstringrequired
3 additional input fields
format"decimal" | "lowerRoman" | "upperRoman" | "lowerLetter" | "upperLetter"
includeChapterboolean
chapterStylestring

Result

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