Skip to content

11. Canonical schema for admin-managed org config.yaml (v1)

Date: 2026-04-05

Status

Accepted

Context

ADR 0003 places org-level fullsend configuration in <org>/.fullsend, including a top-level config.yaml. That ADR intentionally deferred exact schema details. The admin CLI and config-repo layer now read and write a concrete v1 document; adopters and tooling need a single normative definition that stays aligned with the implementation.

Decision

The canonical definition of admin-managed config.yaml v1 lives in the Go implementation (internal/config/) and its test suite. Future versions SHOULD introduce a new version value.

Consequences

  • Org configuration in .fullsend can be validated, reviewed, and generated against a stable, published contract.
  • The admin CLI and other tools can share one reference for field names, types, and allowed enumeration values.
  • Broader .fullsend layout (other files, inheritance, guardrails) remains governed by ADR 0003 and is not specified here.
  • Changes to v1 require updating the implementation and tests, and when behavior changes, follow-up design or ADR work.