Skip to main content

SFDS Schema Reference

SFDS ships one adopter-facing schema: STANDARD.manifest.schema.toml. It describes the required shape of every [StandardName].manifest.toml suite manifest across City Hall.

STANDARD.manifest.schema.toml​

title = "Aptlantis Standard Manifest Schema"
type = "object"
required = ["standard", "governance", "artifacts", "lifecycle"]

[properties.standard]
required = ["id", "title", "abbreviation", "status", "maturity", "version"]

[properties.governance]
required = ["meta_standard", "scope"]

[properties.artifacts]
required = ["specification", "adoption_guide", "validation_checklist", "changelog"]

[properties.adopter_artifacts]
description = "Optional adopter-facing schemas, manifest templates, and document templates governed by the standard. These do not replace the entity-named standard suite manifest."

[properties.lifecycle]
required = ["created", "last_updated", "maintainer"]

Field groups​

  • [properties.standard] — the standard's identity block: machine id, human title, abbreviation, active/draft status, SFDS maturity level, and semantic version. Every suite manifest must declare all five.
  • [properties.governance] — declares which meta-standard governs the standard (always SFDS) and states the standard's scope in plain language. WGS manifests additionally record a workspace_standard and non_goals list, though the schema only strictly requires meta_standard and scope.
  • [properties.artifacts] — points at the suite's own required documents: specification, adoption_guide, validation_checklist, and changelog. Optional keys such as schema, templates, examples, validators, governance_notes, and reference_examples are common in mature suites (see WGS's WGS.manifest.toml for a fully populated example).
  • [properties.adopter_artifacts] — optional block distinguishing adopter-facing schemas, manifest templates, and document templates from the suite manifest itself. This is the schema-level expression of the SFDS two-layer manifest model.
  • [properties.lifecycle] — tracks created, last_updated, and maintainer so suite currency can be audited without reading prose.

A concrete filled example of this shape is SFDS.manifest.toml itself, reproduced in the overview.