Skip to content
AggregaAggrega
Select language: English

Aggrega Path-Template Context schema

Generated reference. Do not edit by hand — regenerate from the published JSON Schema.

Schema id: https://aggrega.ai/schemas/path-template-context-v1beta1.schema.json

The variable allowlist consumed by Go templates evaluated against Release.spec.boundaries[].directory and Release.spec.boundaries[].subDirectory (and the per-component subDirectory override) when Aggrega builds the Release. Path templates use missingkey=error (distinct from the global missingkey=zero regime for value templates) plus parse-time validation: every field reference in a path template must appear in this allowlist for the relevant context (directory: vs subDirectory:); unknown fields produce a Loud Guardrail error at parse time, never at render time. The Path-Template Variables page of the language reference teaches the difference from value templates.

Top-level type: object

Properties

PropertyTypeRequiredDescription
capabilitystringnoAvailable in directory: AND subDirectory:. The rendering capability the contributing component’s Recipe declares in spec.capability, with any version pin stripped — for example ‘helm’, ‘helm-chart’ or ‘compose’. subDirectory: defaults to {{ .capability }}, which is what lands each capability’s artifacts in their own sub-folder beneath the boundary’s directory. In a directory: template the value is resolved per-component, so a boundary whose subtree contributes more than one capability evaluates to one directory per capability; the separate per-boundary walk that publishes .parent_boundary.directory runs before any component is bound and leaves this value empty.
boundary_namestringnoAvailable in directory: AND subDirectory:. The map key in release.spec.boundaries..
parametersobjectnoAvailable in directory: AND subDirectory:. Typed parameter map from the Release. Path templates receive .parameters access as a deliberate carve-out from the parameters single-pass lifecycle — value templates do NOT receive .parameters; environment-shaped values flow into value templates via the already-interpolated Aggregate YAML.
component_idstringnoAvailable in subDirectory: ONLY. The identity of the contributor being placed. For a component, its flattened per-component instance ID (e.g., ‘backend’ or ‘data-layer.main-db’). For a Feature attached at a boundary whose FeatureRecipe runs once for the boundary (executionScope: boundary), the composed component identity every resource that attachment emits carries in its aggrega.ai/component-id label (e.g., ‘bfr—app—shared’ for an attachment ‘shared’ at boundary ‘app’), shortened where the attachment’s rendering plugin bounds names, so the directory it names matches that label. Meaningless at boundary-level and rejected by parse-time validation in directory: templates.
parent_boundaryobjectnoAvailable in directory: AND subDirectory:. The parent boundary’s already-resolved values. Populated via depth-first walk evaluating each boundary’s templates with its parent’s resolved values; children never see their own values here. A top-level boundary has no parent, so a key read under parent_boundary there halts the build, naming the boundary, the template field and the missing key.
manifestobjectnoAvailable in directory: AND subDirectory:. Carries the resolved Recipe metadata as evaluated per-component.

Additional properties are not permitted.

path-template-context.parent_boundary

Available in directory: AND subDirectory:. The parent boundary’s already-resolved values. Populated via depth-first walk evaluating each boundary’s templates with its parent’s resolved values; children never see their own values here. A top-level boundary has no parent, so a key read under parent_boundary there halts the build, naming the boundary, the template field and the missing key.

PropertyTypeRequiredDescription
directorystringnoParent’s evaluated directory string.
boundary_namestringnoParent’s name (the map key in release.spec.boundaries).
parametersobjectnoThe Release’s parameter map — the same map .parameters carries.
annotationsmap of stringnoThe parent boundary’s annotations after the cascade resolves.

Additional properties are not permitted.

path-template-context.manifest

Available in directory: AND subDirectory:. Carries the resolved Recipe metadata as evaluated per-component.

PropertyTypeRequiredDescription
recipe_namestringnoThe resolved Recipe’s name from the per-component lookup.

Additional properties are not permitted.