Document apiReferenceHeader footers

headerFooters.resolve

Resolve the effective header/footer reference for a slot, walking the section inheritance chain.

read-onlyidempotent
doc.headerFooters.resolve(…)

Expected result

Returns a HeaderFooterResolveResult indicating explicit, inherited, or none status with the resolved refId.

Inputs

targetobjectrequired
Fields
kind"headerFooterSlot"required
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required

Result

Output fields
explicit
status"explicit"required
refIdstringrequired
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
inherited
status"inherited"required
refIdstringrequired
resolvedFromSectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
resolvedVariant"default" | "first" | "even"required
none
status"none"required

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT

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