Skip to content
AggregaAggrega
Select language: English

Aggrega Dependency Lockfile (Manifest) schema

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

Schema id: https://aggrega.ai/schemas/manifest-v1beta1.schema.json

A single, global lockfile that maps abstract component and Feature types to concrete Recipe and FeatureRecipe implementations, by type, with a per-instance override by name.

See the Manifest authoring reference for prose guidance on authoring Manifest entities; this page documents the structural schema that reference describes.

Top-level type: object

Properties

PropertyTypeRequiredDescription
apiVersionconst “aggrega.ai/v1beta1”yesConstant: "aggrega.ai/v1beta1"
kindconst “Manifest”yesConstant: "Manifest"
metadataobjectyes
defsstring[]noOptional block for standard YAML anchors (& and *) to keep the Manifest DRY while maintaining a flat O(1) dictionary for the compiler.
specobjectyesThe Manifest’s mapping declarations plus optional base inheritance: mappings connects abstract component and feature types to concrete Recipe and FeatureRecipe implementations; extends inherits mappings from a base Manifest.

Additional properties are not permitted.

manifest.metadata

PropertyTypeRequiredDescription
namestringyesAt least 1 character long.
versionstringyesStrict Semantic Versioning of the manifest lockfile (e.g., 1.0.0). Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$.
descriptionstringnoWhat this entity is and what it is for, written for someone deciding whether to use it. Open with a sentence naming the thing, then add what a reader needs in order to choose it and use it correctly — what it expects from the Release that uses it, and anything surprising about how it behaves. A short paragraph is the usual length.
maintainersobject[]noList of maintainers who own this entity.
licensestringnoSPDX identifier for the license of the software this entity describes, such as MIT or AGPL-3.0. It records the terms of that software, not the terms of this file.
repositorystringnoThe URL to the Git repository where the source files live.
homestringnoThe URL of this entity’s home page, wiki, or documentation.
keywordsstring[]noA list of descriptive keywords for UI discoverability.

Additional properties are not permitted.

manifest.metadata.maintainers[]
PropertyTypeRequiredDescription
namestringyes
emailstringno
urlstringno

Additional properties are not permitted.

manifest.spec

The Manifest’s mapping declarations plus optional base inheritance: mappings connects abstract component and feature types to concrete Recipe and FeatureRecipe implementations; extends inherits mappings from a base Manifest.

PropertyTypeRequiredDescription
extendsstringnoURI of a base Manifest to inherit mappings from. A child’s mapping replaces the base’s for the same key.
mappingsobjectyesMaps abstract interfaces to concrete implementations. Declare mappings under the top-level keys ‘components’ and ‘features’, each mapping component-type / feature-type URIs directly to Recipe / FeatureRecipe URIs. These two keys are the whole surface; no other key is accepted here. The mapping is capability-agnostic at the Manifest layer — capability determination flows from each resolved Recipe’s spec.capability when Aggrega builds the Release. Keys: One of "components", "features".

Additional properties are not permitted.

manifest.spec.mappings

Maps abstract interfaces to concrete implementations. Declare mappings under the top-level keys ‘components’ and ‘features’, each mapping component-type / feature-type URIs directly to Recipe / FeatureRecipe URIs. These two keys are the whole surface; no other key is accepted here. The mapping is capability-agnostic at the Manifest layer — capability determination flows from each resolved Recipe’s spec.capability when Aggrega builds the Release.

PropertyTypeRequiredDescription
componentsmapping_tiernoComponent-type to Recipe URI mapping. A Recipe URI carries at most two segments — an optional leading capability, then the recipe name — plus an optional version; a reference with a third segment matches no recipe. Version forms: exact (‘postgres-bitnami:1.2.0’), range (‘postgres-bitnami:^1.2.0’), or unversioned (‘postgres-bitnami’); the resolver pins the resolved version in the lockfile at first resolve. A reference may additionally be capability-qualified (‘terraform/mariadb-rds:1.0.0’, the segment before the first ’/’ naming the recipe’s spec.capability) — required when more than one recipe ships the same name; an ambiguous bare reference halts resolution loudly rather than silently picking one.
featuresmapping_tiernoFeature-type to FeatureRecipe URI mapping. Includes both operational Features and credential Features (labeled feature.aggrega.ai/kind: secret).

Keys: One of "components", "features".

Additional properties are not permitted.

Definitions

mapping_tier

Two-tier resolution: ‘type’ maps by catalog type (DRY bulk), ‘name’ maps by instance name (granular override). Both are optional but at least one must be present. Name wins over type during resolution. Versioned type keys win over unversioned.

PropertyTypeRequiredDescription
typemap of stringnoMaps catalog type URIs to Recipe URIs. Supports versioned keys (‘core/api-server:1.0.0’) for exact match, range keys (‘core/api-server:^1.0.0’) for major-compatible match, or unversioned keys (‘core/api-server’) for any-version match.
namemap of stringnoMaps specific instance names to Recipe URIs. Takes precedence over type-based mapping.
annotationsmap of objectnoAnnotation-driven Feature shortcuts. Maps annotation keys to a Feature URI plus a pillar-grouped routing table from dotted-path subkey to Feature pillar (values or infra). Validation derives from the target Feature’s spec.schema.. declaration; the binding declares routing only. The Feature URI referenced by ‘feature’ MUST also appear in the ‘type’ section (that is where the FeatureRecipe version binding lives).

Additional properties are not permitted.