Skip to main content

AADR Schema Reference

Standard Manifest​

AADR.manifest.toml declares AADR as an active, candidate-maturity standard suite, its governance relationships, and the artifacts that make up the suite.

[standard]
id = "aadr"
title = "Application as Data Representation Standard"
abbreviation = "AADR"
status = "active"
maturity = "candidate"
version = "1.0.3"
description = "Governs emerging application-as-data representation records, component maps, relationship maps, architecture references, and compatibility limits."

[governance]
meta_standard = "SFDS"
workspace_standard = "WGS"
scope = "Application-as-data representation records, component maps, relationship records, source architecture references, compatibility limits, and representation validation."
non_goals = ["Desktop release packaging", "CLI output contracts", "visual theme contracts"]

[artifacts]
specification = "Application as Data Representation Standard.md"
schema = "RepresentationRecord.schema.toml"
templates = "templates"
examples = "examples"
adoption_guide = "Adoption-Guide.md"
validation_checklist = "Validation-Checklist.md"
changelog = "CHANGELOG.md"
validators = []
governance_notes = ["AptlantisEcosystem/Standards/AADR v1.0.md"]
reference_examples = [
  "examples/AADR-Suite-Map.md",
  "examples/Example-Representation-Record.md"
]

[adopter_artifacts]
schemas = ["RepresentationRecord.schema.toml"]
manifest_templates = []
document_templates = ["templates/Representation-Record.md"]

[lifecycle]
created = "2026-06-10"
last_updated = "2026-06-11"
maintainer = "Herb"

[agent]
read_first = ["README.md", "Application as Data Representation Standard.md", "AptlantisEcosystem/Standards/AADR v1.0.md"]
notes = "AADR remains candidate while representation patterns mature. Do not imply executable completeness unless validation proves it."
  • [standard] — identity, status, and version of the standard itself.
  • [governance] — where AADR sits relative to SFDS (the meta-standard governing standard suites) and WGS (the workspace standard governing placement); also lists explicit non-goals.
  • [artifacts] — the canonical files that make up the suite: specification, schema, templates, examples, adoption guide, checklist, and changelog.
  • [adopter_artifacts] — what an adopting project actually consumes: schemas and document templates.
  • [lifecycle] — creation and update dates and the maintainer of record.
  • [agent] — a read-order hint for agents picking up the standard, plus a caution against overstating executable completeness.

Representation Record Schema​

RepresentationRecord.schema.toml defines the required shape of a representation record: what fields must be present for a record to be considered valid.

title = "AADR Representation Record Schema"
type = "object"
required = ["subject", "representation_level", "components", "relationships", "compatibility_limits", "validation"]

[properties.subject]
required = ["application", "representation_id", "version", "created"]

[properties.representation_level]
required = ["level", "completeness", "executable"]

[properties.components]
type = "array"

[properties.relationships]
type = "array"

[properties.compatibility_limits]
type = "array"

[properties.validation]
required = ["checked_by", "checked_on", "result"]
  • subject — identifies the application being represented, a representation ID, version, and creation date.
  • representation_level — the maturity level of the record (sketch through archived), whether it is complete, and whether it is executable.
  • components / relationships — arrays describing the pieces of the system and how they connect.
  • compatibility_limits — an array of stated limits on what the representation can be trusted to describe.
  • validation — who checked the record, when, and the result of that check.