Skema Aggrega Dependency Lockfile (Manifest)
Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.
Id skema: https://aggrega.ai/schemas/manifest-v1beta1.schema.json
Satu lockfile global yang memetakan tipe abstrak component dan Feature ke implementasi Recipe dan FeatureRecipe yang konkret, berdasarkan tipe, dengan penimpaan per instans berdasarkan nama.
Lihat referensi penulisan Manifest untuk panduan prosa tentang penulisan entitas Manifest; halaman ini mendokumentasikan skema struktural yang dijelaskan oleh referensi tersebut.
Jenis tingkat teratas: object
Properti
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | ya | Konstanta: "aggrega.ai/v1beta1" |
kind | const “Manifest” | ya | Konstanta: "Manifest" |
metadata | object | ya | |
defs | string[] | tidak | Blok opsional untuk anchor YAML standar (& dan *) agar Manifest tetap DRY sambil mempertahankan kamus O(1) yang datar bagi kompiler. |
spec | object | ya | Deklarasi pemetaan Manifest beserta pewarisan basis opsional: mappings menghubungkan jenis component dan feature abstrak ke implementasi Recipe dan FeatureRecipe konkret; extends mewarisi pemetaan dari Manifest basis. |
Properti tambahan tidak diizinkan.
manifest.metadata
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
name | string | ya | Panjang minimal 1 karakter. |
version | string | ya | Semantic Versioning ketat dari lockfile manifest (misalnya, 1.0.0). Pola: ^(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 | tidak | Apa entitas ini dan untuk apa, ditulis bagi seseorang yang sedang memutuskan apakah akan menggunakannya. Awali dengan kalimat yang menyebutkan hal tersebut, lalu tambahkan apa yang perlu diketahui pembaca untuk memilih dan menggunakannya dengan benar — apa yang diharapkannya dari Release yang menggunakannya, dan apa pun yang mengejutkan tentang perilakunya. Satu paragraf pendek adalah panjang yang lazim. |
maintainers | object[] | tidak | Daftar pemelihara yang memiliki entitas ini. |
license | string | tidak | Pengidentifikasi SPDX untuk lisensi perangkat lunak yang dideskripsikan entitas ini, seperti MIT atau AGPL-3.0. Pengidentifikasi ini mencatat ketentuan perangkat lunak tersebut, bukan ketentuan berkas ini. |
repository | string | tidak | URL ke repositori Git tempat berkas sumber berada. |
home | string | tidak | URL halaman beranda, wiki, atau dokumentasi entitas ini. |
keywords | string[] | tidak | Daftar kata kunci deskriptif untuk kemudahan penemuan di UI. |
Properti tambahan tidak diizinkan.
manifest.metadata.maintainers[]
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
name | string | ya | |
email | string | tidak | |
url | string | tidak |
Properti tambahan tidak diizinkan.
manifest.spec
Deklarasi pemetaan Manifest beserta pewarisan basis opsional: mappings menghubungkan jenis component dan feature abstrak ke implementasi Recipe dan FeatureRecipe konkret; extends mewarisi pemetaan dari Manifest basis.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
extends | string | tidak | URI Manifest basis tempat pemetaan diwarisi. Untuk kunci yang sama, pemetaan turunan menggantikan pemetaan basis. |
mappings | object | ya | Memetakan antarmuka abstrak ke implementasi konkret. Deklarasikan pemetaan di bawah kunci tingkat atas ‘components’ dan ‘features’, masing-masing memetakan URI component-type / feature-type langsung ke URI Recipe / FeatureRecipe. Kedua kunci ini adalah seluruh permukaannya; tidak ada kunci lain yang diterima di sini. Pemetaan bersifat agnostik terhadap kapabilitas pada lapisan Manifest — penentuan kapabilitas berasal dari spec.capability setiap Recipe yang di-resolve saat Aggrega mem-build Release. Kunci: Salah satu dari "components", "features". |
Properti tambahan tidak diizinkan.
manifest.spec.mappings
Memetakan antarmuka abstrak ke implementasi konkret. Deklarasikan pemetaan di bawah kunci tingkat atas ‘components’ dan ‘features’, masing-masing memetakan URI component-type / feature-type langsung ke URI Recipe / FeatureRecipe. Kedua kunci ini adalah seluruh permukaannya; tidak ada kunci lain yang diterima di sini. Pemetaan bersifat agnostik terhadap kapabilitas pada lapisan Manifest — penentuan kapabilitas berasal dari spec.capability setiap Recipe yang di-resolve saat Aggrega mem-build Release.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
components | mapping_tier | tidak | Pemetaan tipe Component ke URI Recipe. Sebuah URI Recipe memuat paling banyak dua segmen — capability di depan yang bersifat opsional, lalu nama recipe — ditambah versi opsional; referensi dengan segmen ketiga tidak cocok dengan recipe mana pun. Bentuk versi: tepat (‘postgres-bitnami:1.2.0’), rentang (‘postgres-bitnami:^1.2.0’), atau tanpa versi (‘postgres-bitnami’); resolver menyematkan versi hasil resolusi di lockfile pada resolusi pertama. Sebuah referensi juga dapat dikualifikasi dengan capability (‘terraform/mariadb-rds:1.0.0’, segmen sebelum ’/’ pertama menyebutkan spec.capability milik recipe) — wajib bila lebih dari satu recipe memiliki nama yang sama; referensi polos yang ambigu menghentikan resolusi secara tegas alih-alih diam-diam memilih salah satunya. |
features | mapping_tier | tidak | Pemetaan feature-type ke URI FeatureRecipe. Mencakup Features operasional maupun Features kredensial (berlabel feature.aggrega.ai/kind: secret). |
Kunci: Salah satu dari "components", "features".
Properti tambahan tidak diizinkan.
Definisi
mapping_tier
Resolusi dua tingkat: ‘type’ memetakan berdasarkan jenis katalog (massal DRY), ‘name’ memetakan berdasarkan nama instans (penimpaan granular). Keduanya opsional, tetapi setidaknya satu harus ada. Name lebih diutamakan daripada type selama resolusi. Kunci type berversi lebih diutamakan daripada yang tanpa versi.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
type | map of string | tidak | Memetakan URI jenis katalog ke URI Recipe. Mendukung kunci berversi (‘core/api-server:1.0.0’) untuk kecocokan tepat, kunci rentang (‘core/api-server:^1.0.0’) untuk kecocokan yang kompatibel secara mayor, atau kunci tanpa versi (‘core/api-server’) untuk kecocokan versi apa pun. |
name | map of string | tidak | Memetakan nama instans tertentu ke URI Recipe. Lebih diutamakan daripada pemetaan berbasis type. |
annotations | map of object | tidak | Pintasan Feature berbasis anotasi. Memetakan kunci anotasi ke URI Feature beserta tabel routing yang dikelompokkan per pilar, dari subkunci jalur bertitik ke pilar Feature (values atau infra). Validasi diturunkan dari deklarasi spec.schema. |
Properti tambahan tidak diizinkan.