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
| Property | Type | Required | Description |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | yes | Constant: "aggrega.ai/v1beta1" |
kind | const “ArtifactLibrary” | yes | Constant: "ArtifactLibrary" |
metadata | object | yes | |
spec | object | yes | 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. |
Additional properties are not permitted.
artifactlibrary.metadata
| Property | Type | Required | Description |
|---|---|---|---|
name | string | yes | PascalCase identifier for the library. It is the ^[A-Z][A-Za-z0-9]*$. |
version | string | yes | Strict 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 (^(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-]+)*))?$. |
description | string | no | A concise summary of what the library covers. |
labels | map of string | no | Author-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. |
annotations | map of string | no | Author-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.
| Property | Type | Required | Description |
|---|---|---|---|
artifacts | map of map of string | yes | Named 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 ^[A-Z][A-Za-z0-9]*$. At least 1 entry. |
Additional properties are not permitted.