Aggrega Catalog (WorkloadLibrary) schema
Generated reference. Do not edit by hand — regenerate from the published JSON Schema.
Schema id: https://aggrega.ai/schemas/workloadlibrary-v1beta1.schema.json
A reusable collection of Workload template fragments that Recipes consume at render time via workload: { $import: ... }. Tier 3 — opt-in for catalogs that need cross-Recipe workload reuse. Single authoring mode: Go templates only.
See the WorkloadLibrary authoring reference for prose guidance on authoring WorkloadLibrary 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 “WorkloadLibrary” | yes | Constant: "WorkloadLibrary" |
metadata | object | yes | |
spec | object | yes | The WorkloadLibrary’s content. spec.workloads is required and must declare at least one entry. spec carries additionalProperties: false — no parallel authoring modes are accepted at the envelope level. The single-authoring-mode posture keeps Recipe rendering uniform (Go template throughout) and avoids forcing authors to switch evaluation models mid-render when consuming imported fragments. |
Additional properties are not permitted.
workloadlibrary.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.
workloadlibrary.spec
The WorkloadLibrary’s content. spec.workloads is required and must declare at least one entry. spec carries additionalProperties: false — no parallel authoring modes are accepted at the envelope level. The single-authoring-mode posture keeps Recipe rendering uniform (Go template throughout) and avoids forcing authors to switch evaluation models mid-render when consuming imported fragments.
| Property | Type | Required | Description |
|---|---|---|---|
workloads | map of string | yes | Named map of reusable Workload template fragments. Each entry’s 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 (#/workloads/<name>); the envelope-level constraint prevents non-PascalCase keys from propagating through the catalog ecosystem. Pattern: ^[A-Z][A-Za-z0-9]*$. At least 1 entry. |
Additional properties are not permitted.