1.0.0Epistola 1.0 is now generally available.
Work in progress — The Learn section is being expanded; alpha, beta, and preview capabilities are labelled where relevant.
← Back to Documentation

Data Contract Reference

Technical guidance for expected document data, validation, and example payloads.

Data contract reference

Expected data describes the fields a template needs before it can generate a document. The user-facing explanation is in Expected Data.

Contract format

The Suite stores the expected data model as JSON Schema. Use it to describe field names, required values, nested objects, lists, and validation constraints.

Keep field names stable once connected systems depend on them. If a meaning changes, add a new field or create a versioned migration path.

Examples

Maintain examples beside the contract. They are used by template editors, reviewers, previews, and integration tests.

Good examples should include:

  • A common successful case.
  • A case with optional fields omitted.
  • Boundary values that often cause formatting or legal wording changes.

Validation responsibility

Epistola can validate whether required data is present and structurally correct. The source system remains responsible for business correctness: whether the case value is the right value for the document.