Skip to content
AggregaAggrega
Select language: English

Aggrega Catalog (ArtifactLibrary) schema

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

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

A reusable collection of named artifact bundles that Recipes and FeatureRecipes consume at render time via artifacts.<name>: { $import: ... }. Each bundle is a set of output files imported as one unit. Tier 3 — opt-in for catalogs that need cross-Recipe artifact reuse. Single authoring mode: Go templates only.

See the ArtifactLibrary authoring reference for prose guidance on authoring ArtifactLibrary 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 “ArtifactLibrary”yesConstant: "ArtifactLibrary"
metadataobjectyes
specobjectyesThe ArtifactLibrary’s content. spec.artifacts is required and must declare at least one bundle. spec carries additionalProperties: false — no parallel authoring modes are accepted at the envelope level. The single-authoring-mode posture keeps rendering uniform (Go template throughout) and avoids forcing authors to switch evaluation models mid-render when consuming imported bundles.

Additional properties are not permitted.

artifactlibrary.metadata

PropertyTypeRequiredDescription
namestringyesPascalCase identifier for the library. It is the name in the bare-name identity reference #/artifacts/; the version is supplied by the per-Release lockfile and no registry host enters the reference or any derived identifier. Pattern: ^[A-Z][A-Za-z0-9]*$.
versionstringyesStrict Semantic Versioning of the library (e.g., 1.0.0). A consumer may assert this as an optional :<version> minimum-version floor in a bare-name reference (:#/artifacts/); the per-Release lockfile owns the resolved version. 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-]+)*))?$.
descriptionstringnoA concise summary of what the library covers.
labelsmap of stringnoAuthor-declared labels. The compiler is content-neutral and does not interpret label values: they are opaque metadata, carried for whatever reads the library to match on.
annotationsmap of stringnoAuthor-declared annotations. Same opaque-metadata posture as labels.

Additional properties are not permitted.

artifactlibrary.spec

The ArtifactLibrary’s content. spec.artifacts is required and must declare at least one bundle. spec carries additionalProperties: false — no parallel authoring modes are accepted at the envelope level. The single-authoring-mode posture keeps rendering uniform (Go template throughout) and avoids forcing authors to switch evaluation models mid-render when consuming imported bundles.

PropertyTypeRequiredDescription
artifactsmap of map of stringyesNamed map of reusable artifact bundles. Each bundle groups the output files that belong together (for example a CRD, its RBAC, and a ConfigMap). Each file body is opaque to the envelope validation — content semantics are handled by the Go template parser at consumption time. Keys: PascalCase identifier. Entry keys appear in canonical reference URLs (#/artifacts/<name>); the envelope-level constraint prevents non-PascalCase keys from propagating through the catalog ecosystem. The addresses the whole bundle, never an individual file within it. Pattern: ^[A-Z][A-Za-z0-9]*$. At least 1 entry.

Additional properties are not permitted.