Lewati ke konten
AggregaAggrega
Pilih Bahasa: Bahasa Indonesia
Halaman ini diterjemahkan oleh mesin. Baca versi asli dalam bahasa Inggris.

Skema Aggrega Core (Plugin)

Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.

Id skema: https://aggrega.ai/schemas/plugin-v1beta1.schema.json

Sebuah plugin Wasm: modul WebAssembly yang dipublikasikan ke registri OCI dan diidentifikasi oleh metadata.pluginType-nya — soket yang diimplementasikannya — ditambah metadata.name polosnya, yang mendeklarasikan versi ABI yang ditargetkannya, penunjuk tanda tangan opsional, dan blok runtime opsional. Entitas dan .wasm-nya dipublikasikan sebagai satu manifest OCI yang diberi tag metadata.version — YAML entitas sebagai blob konfigurasi manifest tersebut, .wasm sebagai layer inline, ditandatangani satu kali. Identitas adalah koordinat metadata.pluginType/metadata.name ditambah metadata.version entitas; lokasi .wasm diturunkan dari koordinat tersebut ditambah registri yang dikonfigurasi, dan digest konten yang telah di-resolve disimpan di lockfile, bukan di entitas. Lockfile mencatat digest tersebut, dan kebijakan kepercayaan per registri memverifikasi tanda tangan artefak saat pull. Kompiler tidak menafsirkan perilaku plugin — kompiler merutekan referensinya; runtime WebAssembly mengeksekusi byte-nya.

Lihat referensi penulisan Plugin untuk panduan prosa tentang penulisan entitas Plugin; halaman ini mendokumentasikan skema struktural yang dijelaskan oleh referensi tersebut.

Jenis tingkat teratas: object

Properti

PropertiJenisWajibDeskripsi
apiVersionconst “aggrega.ai/v1beta1”yaKonstanta: "aggrega.ai/v1beta1"
kindconst “Plugin”yaKonstanta: "Plugin"
metadataobjectya
specobjectyaVersi ABI yang ditargetkan plugin, penunjuk tanda tangan opsional, dan blok runtime opsional. Lokasi .wasm plugin diturunkan dari identitas plugin — metadata.pluginType miliknya (soket) ditambah metadata.name polosnya — dan registry yang dikonfigurasi; lokasi ini tidak dibawa di dalam spec.

Properti tambahan tidak diizinkan.

plugin.metadata

PropertiJenisWajibDeskripsi
namestringyaPanjang minimal 1 karakter.
versionstringyaSemantic Versioning ketat dari entitas Plugin (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-]+)*))?$.
pluginTypestring (enum)yaJenis soket yang diimplementasikan plugin ini. Sebuah plugin mengimplementasikan tepat satu jenis soket, yang diambil dari taksonomi jenis plugin yang dikenali runtime: provider (merender node IR menjadi artefak asli provider), linter (memeriksa konten yang ditulis dan memunculkan diagnostik), pipeline-step (langkah dalam pipeline: sebuah FeatureRecipe atau Recipe yang menambal himpunan dokumen yang dirender), governance (melayani peran tata kelola build-pipeline — mentransformasi label node saat konstruksi topologi, atau memberikan putusan terima/tolak atas graf IR saat analisis statis atau atas artefak yang dirender saat perenderan; peran tempat plugin dilampirkan, bukan jenisnya, yang menentukan apa yang boleh dihasilkannya), cli (menyumbangkan subperintah runtime aggrega <cmd> yang dipanggil operator di baris perintah — soket runtime, berbeda dari soket render dan pipeline saat kompilasi), parser (mengubah teks sumber asing menjadi pohon terstruktur kanonis sehingga konsumen membaca pohon tersebut tanpa membawa parser bahasanya sendiri, dengan mengiklankan format yang ditanganinya sebagai kapabilitas parse:<format>), importer (mengubah sumber infrastruktur atau definisi agen asing menjadi draf file penulisan Aggrega, dengan mengiklankan format yang ditanganinya sebagai kapabilitas import:<format>). Nilai yang diizinkan: "provider", "linter", "pipeline-step", "governance", "cli", "parser", "importer"
descriptionstringtidakApa 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 build yang menjalankannya, dan apa pun yang mengejutkan tentang perilakunya. Satu paragraf pendek adalah panjang yang lazim.
maintainersobject[]tidakDaftar pemelihara yang memiliki entitas ini.
licensestringtidakPengidentifikasi 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.
repositorystringtidakURL ke repositori Git tempat berkas sumber berada.
homestringtidakURL halaman beranda, wiki, atau dokumentasi entitas ini.
keywordsstring[]tidakDaftar kata kunci deskriptif untuk kemudahan penemuan di UI.

Properti tambahan tidak diizinkan.

plugin.metadata.maintainers[]
PropertiJenisWajibDeskripsi
namestringya
emailstringtidak
urlstringtidak

Properti tambahan tidak diizinkan.

plugin.spec

Versi ABI yang ditargetkan plugin, penunjuk tanda tangan opsional, dan blok runtime opsional. Lokasi .wasm plugin diturunkan dari identitas plugin — metadata.pluginType miliknya (soket) ditambah metadata.name polosnya — dan registry yang dikonfigurasi; lokasi ini tidak dibawa di dalam spec.

PropertiJenisWajibDeskripsi
abiVersionstring (enum)yaVersi ABI host/guest yang ditargetkan plugin. v1beta1 adalah satu-satunya nilai yang diterima; Plugin yang mendeklarasikan versi ABI yang tidak lagi didukung compiler ini akan ditolak, dengan menyebut versi yang harus dipakai untuk membangun ulang plugin. Nilai yang diizinkan: "v1beta1"
signatureobjecttidakPenunjuk deskriptif opsional ke tanda tangan yang dilampirkan pada plugin. Blok ini hanya dokumentasi — blok ini mencatat di mana tanda tangan berada dan bagaimana tanda tangan itu dibuat bagi pembaca katalog; blok ini sendiri tidak menyaring atau menerima plugin. Pemeriksaan yang menegakkan adalah kebijakan kepercayaan per registry yang diterapkan saat pull: tanda tangan diambil sebagai referrer OCI, diverifikasi terhadap identitas tepercaya registry atau kunci yang disematkan, dan dicatat sebagai fakta terverifikasi di lockfile. Registry yang mewajibkan tanda tangan menghentikan pull ketika tanda tangan yang diwajibkan tidak ada, tidak tepercaya, atau tidak valid.
runtimeobjecttidakBatasan eksekusi opsional yang diterapkan host saat memuat dan menjalankan plugin. Akses jaringan keluar bukan field penulisan: plugin tidak pernah menjangkau jaringan saat build (batas ahead-of-time), sehingga tidak ada field host-allowlist untuk ditulis di sini.
exportsobject[]tidakExport yang ditawarkan plugin ini, masing-masing dengan kapabilitas yang dideklarasikan. Export adalah satu titik masuk bernama yang menjadi tujuan dispatch host (misalnya render_node, lint_naming, step); blok kapabilitas per export adalah klaim tertulis tentang apa yang dilakukan export tersebut, yang diperiksa silang oleh host terhadap laporan mandiri plugin saat publish dan saat load. Entri mempertahankan urutan penulis. Jika tidak ada, tidak ada permukaan export tertulis yang dideklarasikan.
commandsobject[]tidakDikelola mesin, jangan ditulis: dicatat oleh aggrega plugin sync (atau aggrega plugin gen-catalog) dari laporan mandiri plugin. Verba tingkat atas aggrega <command> yang disumbangkan plugin CLI dibaca dari laporan mandiri plugin dan dicatat di sini dalam urutan yang dideklarasikan laporan mandiri tersebut, sehingga permukaan perintah yang dipasang plugin CLI dapat dibaca dari entitas tanpa memuat plugin. Plugin non-CLI tidak menyumbangkan perintah dan mencatat daftar kosong. Host memasang tepat himpunan ini; himpunan tercatat yang menyimpang dari laporan mandiri plugin akan berhenti saat load, dan publish menolak himpunan yang tidak sinkron dengan biner serta mengarahkan penulis untuk mencatatnya ulang.
providerobjecttidakBlok soket provider untuk plugin pluginType: provider: kapabilitas yang dilayaninya, cara menerjemahkan kind Workload aggrega.ai/v1beta1, anotasi asli platform yang dibacanya, dan kontrak perilaku render-nya. Hanya ada pada plugin yang merender provider; tidak ada pada semua jenis plugin lainnya.
pipelineStepobjecttidakBlok pipeline-step untuk plugin pluginType: pipeline-step: kapabilitas provider yang kompatibel dengan langkahnya. Hanya ada pada plugin pipeline-step; tidak ada pada semua jenis plugin lainnya.
parserobjecttidakBlok parser untuk plugin pluginType: parser: format sumber yang diubahnya menjadi pohon terstruktur kanonis. Hanya ada pada plugin parser; tidak ada pada semua jenis plugin lainnya.
importerobjecttidakBlok importer untuk plugin pluginType: importer: format sumber asing yang diubahnya menjadi draf file penulisan Aggrega, dan tanda pengenal yang digunakan untuk mengenali sumber dengan format tersebut. Hanya ada pada plugin importer; tidak ada pada semua jenis plugin lainnya.

Properti tambahan tidak diizinkan.

plugin.spec.signature

Penunjuk deskriptif opsional ke tanda tangan yang dilampirkan pada plugin. Blok ini hanya dokumentasi — blok ini mencatat di mana tanda tangan berada dan bagaimana tanda tangan itu dibuat bagi pembaca katalog; blok ini sendiri tidak menyaring atau menerima plugin. Pemeriksaan yang menegakkan adalah kebijakan kepercayaan per registry yang diterapkan saat pull: tanda tangan diambil sebagai referrer OCI, diverifikasi terhadap identitas tepercaya registry atau kunci yang disematkan, dan dicatat sebagai fakta terverifikasi di lockfile. Registry yang mewajibkan tanda tangan menghentikan pull ketika tanda tangan yang diwajibkan tidak ada, tidak tepercaya, atau tidak valid.

PropertiJenisWajibDeskripsi
typeconst “sigstore-cosign”yaSkema tanda tangan. sigstore-cosign adalah skema yang didukung. Konstanta: "sigstore-cosign"
signatureRefstringtidakReferensi referrer OCI dari bundel tanda tangan yang dilampirkan, untuk dokumentasi dan penemuan. Tidak ada ketika tanda tangan ditemukan melalui enumerasi referrer saat pull alih-alih disematkan di sini.
publicKeyRefstringtidakPenunjuk ke kunci publik yang digunakan untuk membuat tanda tangan, untuk tanda tangan berkunci. Jika tidak ada, tanda tangan bersifat tanpa kunci (identitas OIDC), yang diverifikasi terhadap identitas tepercaya registry.

Properti tambahan tidak diizinkan.

plugin.spec.runtime

Batasan eksekusi opsional yang diterapkan host saat memuat dan menjalankan plugin. Akses jaringan keluar bukan field penulisan: plugin tidak pernah menjangkau jaringan saat build (batas ahead-of-time), sehingga tidak ada field host-allowlist untuk ditulis di sini.

PropertiJenisWajibDeskripsi
maxMemoryPagesintegertidakMembatasi memori linear plugin dalam satuan halaman Wasm (64 KiB per halaman). Nol atau tidak ada menerapkan batas default platform, sehingga pemuatan tidak pernah tanpa batas; lampiran yang membutuhkan lebih banyak menaikkan nilai ini. Minimum: 0.
timeoutMsintegertidakMembatasi berapa lama kode plugin itu sendiri boleh berjalan selama satu panggilan, dalam milidetik, tanpa menghitung waktu yang dihabiskan di dalam fungsi host yang dipanggilnya. Di Linux, ukurannya adalah waktu prosesor, sehingga waktu menunggu prosesor pada mesin yang sibuk tidak dihitung; di sistem lain, ukurannya adalah waktu yang berlalu. Panggilan pertama ke plugin yang baru dimuat juga menghitung waktu startup plugin itu sendiri. Nol atau tidak ada menerapkan batas default platform, sehingga panggilan tidak pernah tidak dapat dibatalkan; lampiran yang berjalan lebih lama menaikkan nilai ini. Minimum: 0.
hostFunctionsstring[]tidakDikelola mesin, jangan ditulis: fungsi host yang diimpor plugin, dibaca dari bagian impor .wasm oleh aggrega plugin sync (atau aggrega plugin gen-catalog) dan dicatat di sini dalam bentuk kanonis (terurut, tanpa duplikat). Publish menurunkannya ulang dari biner dan menolak entitas yang catatannya berbeda; pull menurunkan ulang dan memverifikasinya kembali. Host mendaftarkan tepat himpunan turunan ini dan memvalidasi setiap entri terhadap allowlist yang dikurasi.
configKVmap of stringtidakKonfigurasi khusus Plugin yang diberikan runtime kepada plugin saat mulai, berupa pasangan kunci/nilai string-ke-string. Entri mempertahankan urutan penulis sehingga catatan yang dihasilkan identik byte demi byte di setiap eksekusi. Jika tidak ada, konfigurasi kosong bawaan runtime tetap berlaku.

Properti tambahan tidak diizinkan.

plugin.spec.exports[]
PropertiJenisWajibDeskripsi
namestringyaNama ABI dari export — nama yang menjadi tujuan dispatch host (misalnya render_node, lint_naming, step). Panjang minimal 1 karakter.
operatesstring (enum)tidakOperasi pipeline yang dilakukan export ini: patch (mengubah dokumen hasil render yang sudah ada) atau emit (menambahkan dokumen baru). Jika tidak ada, tidak ada klaim operasi. Nilai yang diizinkan: "patch", "emit"
scopestring (enum)tidakAkar dokumen tempat export ini beroperasi: own (dokumen hasil render milik node itu sendiri) atau host (dokumen dari component tempat FeatureRecipe bercakupan component dilampirkan). Jika tidak ada, tidak ada klaim cakupan. Nilai yang diizinkan: "own", "host"
selectorstringtidakDeskripsi bebas yang dapat dibaca manusia tentang objek yang ditangani export (misalnya workloads carrying a pod template). Dokumentasi bagi pembaca katalog; compiler tidak menafsirkannya.

Properti tambahan tidak diizinkan.

plugin.spec.commands[]
PropertiJenisWajibDeskripsi
namestringyaKata kerja perintah yang didaftarkan host — token aggrega <name> yang dipanggil operator, dan diskriminator yang diserahkan host kepada plugin saat pemanggilan sehingga satu plugin yang mendukung beberapa perintah dapat merutekan berdasarkan perintah yang dipanggil. Panjang minimal 1 karakter.
descriptionstringtidakTeks bantuan singkat satu baris untuk perintah, yang ditampilkan dalam daftar perintah dan keluaran bantuan. Hanya dokumentasi; host tidak bertindak berdasarkannya.
flagsobject[]tidakFlag perintah, dalam urutan yang dideklarasikan. Setiap entri menyumbangkan satu flag yang didaftarkan host pada perintah sehingga aggrega help menampilkannya seperti flag perintah inti. Perintah tanpa flag membiarkannya kosong. Dalam satu perintah, setiap nama flag dan setiap singkatan muncul sekali, dan tidak ada yang memakai ulang flag yang sudah dimiliki setiap perintah aggrega — --help, -h, dan flag global; host memeriksa hal ini saat menambahkan perintah plugin, dan plugin yang deklarasinya gagal tidak ditambahkan, disertai peringatan.

Properti tambahan tidak diizinkan.

plugin.spec.commands[].flags[]
PropertiJenisWajibDeskripsi
namestringyaNama panjang flag — token —name yang diberikan operator di baris perintah. Setiap flag yang dideklarasikan harus menyebutkannya. Panjang minimal 1 karakter.
shorthandstringtidakAlias pendek opsional flag — bentuk -x yang dapat diberikan operator sebagai pengganti nama panjang — berupa satu huruf atau digit ASCII. Jika tidak ada, flag tidak memiliki alias pendek. Pola: ^[A-Za-z0-9]$.
descriptionstringtidakTeks bantuan satu baris untuk flag, yang ditampilkan dalam keluaran bantuan perintah. Ini adalah dokumentasi opsional; host tidak memvalidasi maupun bertindak berdasarkannya.
typestring (enum)tidakTipe nilai flag — string, bool atau int — dan jenis flag yang ditampilkan oleh bantuan. Jika tidak ada, flag ditampilkan sebagai flag string. Nilai yang diizinkan: "string", "bool", "int"
defaultstringtidakNilai default flag ketika operator tidak memberikannya, dinyatakan sebagai string. Untuk flag bool atau int, nilainya adalah nilai dari tipe tersebut. Jika tidak ada, flag tidak mendeklarasikan nilai default.

Properti tambahan tidak diizinkan.

plugin.spec.provider

Blok soket provider untuk plugin pluginType: provider: kapabilitas yang dilayaninya, cara menerjemahkan kind Workload aggrega.ai/v1beta1, anotasi asli platform yang dibacanya, dan kontrak perilaku render-nya. Hanya ada pada plugin yang merender provider; tidak ada pada semua jenis plugin lainnya.

PropertiJenisWajibDeskripsi
capabilitiesstring[]tidakDicatat dari laporan mandiri .wasm plugin oleh aggrega plugin gen-catalog, sehingga plugin adalah sumber daftar ini. Penulis boleh mempersempitnya sebelum publikasi, dengan menghapus entri yang tidak seharusnya ditawarkan entitas ini, dan tidak boleh menambahkan entri yang tidak disebutkan laporan mandiri: publikasi, dan aggrega validate yang diberi .wasm plugin dengan --plugin, menolak daftar yang menyebutkan kapabilitas yang tidak disebutkan laporan mandiri. Publikasi mengirim entitas sebagaimana ditulis, tanpa pernah menulis ulang daftar ini, dan mencatat setiap kapabilitas yang disebutkan laporan mandiri tetapi tidak dicantumkan daftar. Kapabilitas yang dilayani provider ini — nama kapabilitas seperti helm atau compose — yang bentuk keluarannya dirender olehnya. Sebuah provider bersifat generik di antara artefak yang berbagi bentuk keluaran suatu kapabilitas, bukan di antara semua kapabilitas, sehingga daftar ini adalah klaim kompatibilitas yang eksplisit dan teruji, bukan sekadar aspirasi. Entri mempertahankan urutan penulis. Target provider yang diminta oleh sebuah Recipe di-resolve ke plugin provider yang daftarnya memuat target tersebut; target yang tercantum di lebih dari satu plugin provider dihentikan sebagai ambigu kecuali pilihan plugins.providers dalam konfigurasi workspace menyebutkan plugin mana yang digunakan. Daftar yang kosong atau tidak ada tidak mendeklarasikan klaim kapabilitas apa pun, sehingga plugin tidak melayani target apa pun.
workloadSchemastringtidakJSON Schema 2020-12 yang mendokumentasikan cara provider ini menerjemahkan kind Workload aggrega.ai/v1beta1 menjadi manifest native provider. Jika ada, provider mendukung Recipes yang mendeklarasikan blok workload: (mode tersintesis) — provider menerjemahkan Workload menjadi manifest native provider, dengan skema ini sebagai dokumentasi/kontrak. Apakah sebuah Recipe workload: didukung ditentukan oleh kapabilitas sintesis provider yang terikat, bukan oleh keberadaan field ini: Recipe mode tersintesis yang terikat ke provider yang tidak dapat melakukan sintesis dihentikan secara eksplisit saat render. Katalog pustaka standar mendeklarasikan workloadSchema pada provider yang melakukan sintesis sebagai kontrak terdokumentasi, yang dijaga tetap selaras dengan kapabilitas tersebut. Field ini adalah kontrak terdokumentasi: isinya dikompilasi ke JSON Schema 2020-12 saat pemuatan untuk memeriksa bahwa isinya terbentuk dengan benar, dan tidak ada hal lain yang membacanya.
wellKnownAnnotationsobject[]tidakKlaim dukungan provider: kunci anotasi well-known native platform (namespace aggrega.ai/) yang dibaca provider ini, masing-masing dengan cakupan tempat kunci dibaca dan perilaku yang diterapkan jika kunci tidak ada. Deklarasikan sebuah kunci hanya jika provider membacanya — matriks dukungan yang dipublikasikan dirender dari deklarasi ini, sehingga kunci yang tercantum di sini adalah kunci yang dapat diharapkan penulis untuk mengubah keluaran yang dirender pada cakupan yang disebutkannya. Compiler membaca deklarasi ini dengan dua cara: scope yang menyebut input kind yang tidak diklaim oleh contract.inputKinds milik provider itu sendiri bertentangan dengan klaim lain dalam entitas yang sama, dan build dihentikan dengan menyebutkan kunci dan pertentangannya; dan build memberikan peringatan tentang anotasi aggrega.ai/ yang mencapai sebuah render melalui provider ini jika tidak ada entri yang mencakupnya pada input kind mana pun yang dideklarasikan render tersebut. Field ini terpisah dari aturan yang mengatur pengikatan nilai di bawah prefiks cadangan aggrega.ai/. Jika tidak ada, tidak ada klaim dukungan yang dideklarasikan, dan tidak ada peringatan semacam itu yang dimunculkan untuk provider ini; provider yang tidak membaca satu pun dari kunci ini mendeklarasikan readsNoWellKnownAnnotations sebagai ganti daftar ini. Entri berupa daftar berurutan dan mempertahankan urutan penulis.
readsNoWellKnownAnnotationskonstanta truetidakMenyatakan bahwa provider ini tidak membaca satu pun kunci anotasi native platform dalam namespace aggrega.ai/, yaitu kunci yang dalam kasus lain akan dicantumkan dalam wellKnownAnnotations: sebuah klaim dukungan yang tidak mencakup kunci apa pun, yang merupakan sebuah pernyataan, sedangkan menghilangkan field ini dan wellKnownAnnotations sekaligus berarti diam. Build kemudian memberikan peringatan tentang setiap anotasi aggrega.ai/ yang mencapai sebuah render melalui provider ini, dengan menyebutkan kunci, provider, dan input kind yang dideklarasikan render tersebut; nilainya tetap diteruskan tanpa diubah dan build tidak dihentikan. Hanya true yang boleh ditulis, sehingga menghilangkan field ini tetap menjadi satu-satunya cara untuk tidak menyatakan apa pun. Field ini tidak dapat ditulis bersama wellKnownAnnotations: provider yang membaca sebagian kunci mencantumkan kunci tersebut di sana sebagai gantinya. Konstanta: true
contractobjecttidakKontrak perilaku render yang dideklarasikan sendiri oleh provider: input kind yang direndernya, cara ia merakit keluaran per node dari sebuah dispatch group dan direktori tempat keluaran itu berada, pasangan pembatas template yang diterapkannya pada file artefak yang diimpor, apakah satu instans yang dimuat dapat melayani setiap crossing, apakah ia menghubungkan edge lintas boundary, apakah ia menghormati entri omit, apakah ia menerima file yang dikontribusikan sebuah Recipe ke keluaran bersama boundary-nya, dan file mana yang tidak pernah dikirim ekosistemnya di samping sebuah sumber. Ini adalah catatan saat publikasi dari laporan mandiri plugin provider, yang diperiksa silang oleh host terhadap laporan mandiri tersebut saat publikasi dan saat pemuatan. Jika tidak ada, tidak ada kontrak perilaku render yang dideklarasikan, dan pemeriksaan silang hanya membandingkan klaim per export.

Properti tambahan tidak diizinkan.

plugin.spec.provider.wellKnownAnnotations[]
PropertiJenisWajibDeskripsi
keystringyaKunci anotasi well-known native platform yang dibaca provider (mis., aggrega.ai/namespace). Berada di bawah namespace anotasi aggrega.ai/ yang dicadangkan platform — direktif platform yang dibaca provider. Pola: ^aggrega\.ai/.+.
purposestringyaApa yang dikendalikan anotasi — perilaku rendering yang dipengaruhinya jika ada.
defaultBehaviorstringtidakPerilaku yang diterapkan provider jika anotasi ini tidak ada.
scopestring (enum)[]tidakTempat provider ini membaca kunci. Tiga nilai pertama adalah input kind Recipe dan menyebut jalur render tempat kunci dibaca — sourced untuk sekumpulan file vendored, synthesized untuk Workload yang diwujudkan provider, artifactsStandalone untuk node yang seluruh keluarannya berupa dokumen artefak yang diimpor. Masing-masing harus merupakan input kind yang diklaim oleh contract.inputKinds milik provider ini; menyebut yang tidak diklaim akan menghentikan build. boundary digunakan untuk kunci yang di-resolve sekali per boundary, bukan per node — nama artefak yang dirakit, atau konteks penempatan yang menjadi dasar pembentukan referensi lintas boundary — ketika input kind bukan sumbu yang bermakna, sehingga tidak dicocokkan dengan contract.inputKinds. Kunci yang dibaca di lebih dari satu jalur mencantumkan semuanya. Jika tidak ada, tidak ada klaim per jalur: tidak ada yang diperiksa, dan kunci hanya menyatakan bahwa provider membacanya di suatu tempat. Setidaknya 1 entri. Tidak ada entri yang boleh muncul dua kali. Nilai yang diizinkan untuk setiap entri: "sourced", "synthesized", "artifactsStandalone", "boundary".

Properti tambahan tidak diizinkan.

plugin.spec.provider.contract

Kontrak perilaku render yang dideklarasikan sendiri oleh provider: input kind yang direndernya, cara ia merakit keluaran per node dari sebuah dispatch group dan direktori tempat keluaran itu berada, pasangan pembatas template yang diterapkannya pada file artefak yang diimpor, apakah satu instans yang dimuat dapat melayani setiap crossing, apakah ia menghubungkan edge lintas boundary, apakah ia menghormati entri omit, apakah ia menerima file yang dikontribusikan sebuah Recipe ke keluaran bersama boundary-nya, dan file mana yang tidak pernah dikirim ekosistemnya di samping sebuah sumber. Ini adalah catatan saat publikasi dari laporan mandiri plugin provider, yang diperiksa silang oleh host terhadap laporan mandiri tersebut saat publikasi dan saat pemuatan. Jika tidak ada, tidak ada kontrak perilaku render yang dideklarasikan, dan pemeriksaan silang hanya membandingkan klaim per export.

PropertiJenisWajibDeskripsi
inputKindsobjecttidakJenis input Recipe mana dari ketiganya yang dirender oleh plugin ini: kumpulan file bersumber, workload hasil sintesis, dan node mandiri yang hanya berisi artefak. Setiap field adalah klaim yang independen.
boundaryAssemblystring (enum)tidakCara plugin menggabungkan output render per node dari sebuah grup dispatch: none menulis output setiap node langsung di jalur dispatch; merge melebur fragmen per node menjadi satu dokumen; nest menempatkan output setiap node di bawah posisinya sendiri dalam struktur payung. Jika tidak ada, tidak ada klaim perakitan. Nilai yang diizinkan: "none", "merge", "nest"
artifactDelimitersobjecttidakPasangan pembatas template Go yang diterapkan plugin pada file artefak yang diimpor. Jika tidak ada, berarti pasangan bawaan {{/}}; plugin yang sintaks targetnya bertabrakan dengan pasangan tersebut mendeklarasikan pasangan alternatif di sini.
assemblyNameAnnotationobjecttidakAnotasi boundary yang nilai terselesaikannya menamai artefak yang dirakit plugin dari sebuah grup dispatch. Plugin yang melebur boundary-boundary kontributor dalam satu grup menjadi satu rakitan bernama mendeklarasikan kunci anotasi yang dibacanya dan apakah setiap boundary kontributor harus sepakat atas nilai terselesaikan anotasi tersebut. Jika tidak ada, plugin menamai rakitannya hanya dari jalur dispatch.
reusableInstancebooleantidakApakah satu instance plugin yang dimuat boleh melayani setiap persilangan render, assemble, dan validate dalam sebuah build, alih-alih instance baru untuk setiap persilangan. Dideklarasikan true hanya jika plugin tidak menyimpan state antarpersilangan — fungsi murni dari input per persilangannya — sehingga satu instance menghasilkan output yang identik byte demi byte, baik digunakan ulang maupun dimuat baru. Jika tidak ada (false), instance baru dimuat untuk setiap persilangan, sehingga plugin yang secara konstruksi membawa state terisolasi.
crossBoundaryLinkingbooleantidakApakah plugin menghubungkan edge uses lintas boundary — edge uses yang ujung pemakai dan ujung yang dipakainya dirakit ke dalam grup dispatch yang berbeda — dengan menghasilkan pengkabelan referensi silang native provider melalui kontrak ekspor berpasangan link_publish/link_resolve. Dideklarasikan true hanya jika plugin mengekspor keduanya; klaim yang tidak cocok dengan pasangan ekspor tersebut dihentikan saat pemuatan. Jika tidak ada (false), tidak ada penautan lintas boundary yang dideklarasikan, sehingga host tidak merutekan persilangan tautan apa pun ke plugin.
omitsbooleantidakApakah provider mematuhi entri omit — entri yang menamai unit hasil render yang harus dikeluarkan dari output sebuah node: provider mengeluarkan setiap unit yang cocok dengan suatu entri dari hasil rendernya, dan melaporkan berapa banyak unit yang cocok dengan setiap entri. Ini adalah catatan saat publikasi dari klaim omits yang dibuat laporan mandiri provider, dan nilai yang berbeda dari laporan tersebut dihentikan saat pemuatan. Jika tidak ada (false), tidak ada dukungan semacam itu yang dideklarasikan.
boundaryArtifactsbooleantidakApakah provider menerima file yang dikontribusikan sebuah Recipe ke output bersama dari boundary tempat provider merender, di bawah spec.boundary.artifacts milik Recipe tersebut: compiler menulis setiap file tersebut satu kali, di direktori yang memuat output rakitan boundary, dan target provider memperlakukannya sebagai bagian dari output tersebut. Ini adalah catatan saat publikasi dari klaim boundary_artifacts yang dibuat laporan mandiri provider, dan nilai yang berbeda dari laporan tersebut dihentikan saat pemuatan. Jika tidak ada (false), tidak ada dukungan semacam itu yang dideklarasikan, dan Recipe yang mendeklarasikan blok tersebut untuk provider ini ditolak sebelum apa pun dirender.
nestSegmentstringtidakDirektori tempat target provider ini menempatkan subdirektori milik setiap kontributor, untuk provider yang boundaryAssembly-nya nest — charts untuk chart payung, modules untuk modul root. Compiler menggabungkan direktori ini, nama kontributor, dan jalur masing-masing file. Hanya dibaca untuk provider yang melakukan nesting. Jika tidak ada, subdirektori setiap kontributor ditempatkan langsung di direktori milik boundary. Nilainya menamai satu direktori dan tidak pernah sebuah jalur.
sourceIgnoreobjecttidakFile yang tidak pernah dikirimkan oleh ekosistem provider ini di samping sumber yang direndernya, berupa aturan pengabaian dalam sintaks gitignore — catatan saat publikasi dari aturan source_ignore yang dideklarasikan laporan mandirinya. Ketika seorang penulis mem-pin sebuah Recipe atau FeatureRecipe yang kapabilitasnya dilayani provider ini untuk mereka, aturan-aturan ini digabungkan dengan .aggregaignore milik penulis sendiri dan dicatat dalam entity.lock di samping entitas, bersama nama plugin ini, dan setiap publikasi, perbandingan, dan render berikutnya atas sumber lokal entitas tersebut menerapkan aturan yang tercatat. Jika ada, nilainya harus sama dengan yang dideklarasikan laporan mandiri, dan pemuatan menolak plugin yang laporannya berbeda; jika tidak ada, tidak ada klaim dan tidak dibandingkan.

Properti tambahan tidak diizinkan.

plugin.spec.provider.contract.inputKinds

Jenis input Recipe mana dari ketiganya yang dirender oleh plugin ini: kumpulan file bersumber, workload hasil sintesis, dan node mandiri yang hanya berisi artefak. Setiap field adalah klaim yang independen.

PropertiJenisWajibDeskripsi
sourcedbooleantidakMerender sekumpulan file bersumber (chart, modul, file compose).
synthesizedbooleantidakMerender workload tersintesis menjadi artefak asli provider.
artifactsStandalonebooleantidakMerender node mandiri yang hanya berisi artefak — node yang membawa dokumen artefak yang diimpor dan tanpa source maupun workload.

Properti tambahan tidak diizinkan.

plugin.spec.provider.contract.artifactDelimiters

Pasangan pembatas template Go yang diterapkan plugin pada file artefak yang diimpor. Jika tidak ada, berarti pasangan bawaan {{/}}; plugin yang sintaks targetnya bertabrakan dengan pasangan tersebut mendeklarasikan pasangan alternatif di sini.

PropertiJenisWajibDeskripsi
leftstringyaDelimiter pembuka.
rightstringyaDelimiter penutup.

Properti tambahan tidak diizinkan.

plugin.spec.provider.contract.assemblyNameAnnotation

Anotasi boundary yang nilai terselesaikannya menamai artefak yang dirakit plugin dari sebuah grup dispatch. Plugin yang melebur boundary-boundary kontributor dalam satu grup menjadi satu rakitan bernama mendeklarasikan kunci anotasi yang dibacanya dan apakah setiap boundary kontributor harus sepakat atas nilai terselesaikan anotasi tersebut. Jika tidak ada, plugin menamai rakitannya hanya dari jalur dispatch.

PropertiJenisWajibDeskripsi
annotationstringyaKunci anotasi batas tempat plugin membaca nama artefak hasil perakitan.
requireUniquebooleantidakApakah setiap batas yang berkontribusi pada satu grup dispatch harus sepakat mengenai nilai terselesaikan anotasi tersebut. Jika true, grup yang batas-batas kontributornya menyelesaikan anotasi ke nilai yang berbeda akan menghentikan build; jika false, plugin menerima nilai terselesaikan yang pertama.

Properti tambahan tidak diizinkan.

plugin.spec.provider.contract.sourceIgnore

File yang tidak pernah dikirimkan oleh ekosistem provider ini di samping sumber yang direndernya, berupa aturan pengabaian dalam sintaks gitignore — catatan saat publikasi dari aturan source_ignore yang dideklarasikan laporan mandirinya. Ketika seorang penulis mem-pin sebuah Recipe atau FeatureRecipe yang kapabilitasnya dilayani provider ini untuk mereka, aturan-aturan ini digabungkan dengan .aggregaignore milik penulis sendiri dan dicatat dalam entity.lock di samping entitas, bersama nama plugin ini, dan setiap publikasi, perbandingan, dan render berikutnya atas sumber lokal entitas tersebut menerapkan aturan yang tercatat. Jika ada, nilainya harus sama dengan yang dideklarasikan laporan mandiri, dan pemuatan menolak plugin yang laporannya berbeda; jika tidak ada, tidak ada klaim dan tidak dibandingkan.

PropertiJenisWajibDeskripsi
patternsstring[]tidakPola pengabaian milik ekosistem itu sendiri, masing-masing berlaku relatif terhadap root direktori sumber lokal, dalam urutan penerapannya.
filesstring[]tidakNama file pengabaian yang dipatuhi ekosistem di dalam sebuah sumber — .helmignore untuk chart. Baris-baris setiap file tersebut merupakan pola tambahan, yang berlaku relatif terhadap direktori yang memuatnya.

Properti tambahan tidak diizinkan.

plugin.spec.pipelineStep

Blok pipeline-step untuk plugin pluginType: pipeline-step: kapabilitas provider yang kompatibel dengan langkahnya. Hanya ada pada plugin pipeline-step; tidak ada pada semua jenis plugin lainnya.

PropertiJenisWajibDeskripsi
capabilitiesstring[]tidakDicatat dari laporan mandiri .wasm milik plugin oleh aggrega plugin gen-catalog, sehingga plugin adalah sumber daftar ini. Penulis dapat mempersempitnya sebelum publikasi, menghapus entri yang tidak seharusnya ditawarkan entitas ini, dan tidak boleh menambahkan entri yang tidak disebutkan laporan mandiri: publikasi, serta aggrega validate yang diberi .wasm plugin melalui --plugin, menolak daftar yang menyebutkan kapabilitas yang tidak disebutkan laporan mandiri. Publikasi mengirim entitas sebagaimana ditulis, tidak pernah menulis ulang daftar ini, dan mencatat setiap kapabilitas yang disebutkan laporan mandiri tetapi tidak dicantumkan daftar. Kapabilitas provider yang kompatibel dengan langkah pipeline plugin ini — nama kapabilitas provider, seperti helm atau compose, yang output hasil rendernya dapat ditransformasi oleh langkah tersebut. Sebuah langkah ditulis untuk bentuk output satu provider pada satu waktu, sehingga daftar ini merupakan klaim kompatibilitas yang eksplisit dan teruji, bukan sekadar aspirasi. Entri mempertahankan urutan penulis. Ini adalah catatan yang dapat dibaca katalog atas klaim tersebut; build membaca klaim yang sama dari plugin ketika sebuah langkah menyentuh suatu scope dan berhenti jika provider yang merender dokumen scope tersebut tidak termasuk di dalamnya. Daftar yang kosong atau tidak ada tidak mendeklarasikan klaim kompatibilitas, sehingga tidak ada scope yang menerima langkah tersebut.

Properti tambahan tidak diizinkan.

plugin.spec.parser

Blok parser untuk plugin pluginType: parser: format sumber yang diubahnya menjadi pohon terstruktur kanonis. Hanya ada pada plugin parser; tidak ada pada semua jenis plugin lainnya.

PropertiJenisWajibDeskripsi
capabilitiesstring[]tidakDicatat dari laporan mandiri .wasm milik plugin oleh aggrega plugin gen-catalog, sehingga plugin adalah sumber daftar ini. Penulis dapat mempersempitnya sebelum publikasi, menghapus entri yang tidak seharusnya ditawarkan entitas ini, dan tidak boleh menambahkan entri yang tidak disebutkan laporan mandiri: publikasi, serta aggrega validate yang diberi .wasm plugin melalui --plugin, menolak daftar yang menyebutkan kapabilitas yang tidak disebutkan laporan mandiri. Publikasi mengirim entitas sebagaimana ditulis, tidak pernah menulis ulang daftar ini, dan mencatat setiap kapabilitas yang disebutkan laporan mandiri tetapi tidak dicantumkan daftar. Format sumber yang diubah parser ini menjadi pohon terstruktur kanonis, masing-masing ditulis sebagai parse:<format> — misalnya parse:yaml. Prefiks merupakan bagian dari entri, sehingga satu plugin yang mengiklankan beberapa format mencantumkan satu entri per format. Entri mempertahankan urutan penulis. Format yang diminta diselesaikan ke parser yang daftarnya memuat entri yang cocok; format yang tidak diiklankan parser mana pun menghentikan build, dan format yang diiklankan oleh lebih dari satu plugin parser dihentikan karena ambigu. Daftar yang kosong atau tidak ada tidak mendeklarasikan klaim format, sehingga plugin tidak mem-parse apa pun.

Properti tambahan tidak diizinkan.

plugin.spec.importer

Blok importer untuk plugin pluginType: importer: format sumber asing yang diubahnya menjadi draf file penulisan Aggrega, dan tanda pengenal yang digunakan untuk mengenali sumber dengan format tersebut. Hanya ada pada plugin importer; tidak ada pada semua jenis plugin lainnya.

PropertiJenisWajibDeskripsi
capabilitiesstring[]tidakDicatat dari laporan mandiri .wasm milik plugin oleh aggrega plugin gen-catalog, sehingga plugin adalah sumber daftar ini. Penulis dapat mempersempitnya sebelum publikasi, menghapus entri yang tidak seharusnya ditawarkan entitas ini, dan tidak boleh menambahkan entri yang tidak disebutkan laporan mandiri: publikasi, serta aggrega validate yang diberi .wasm plugin melalui --plugin, menolak daftar yang menyebutkan kapabilitas yang tidak disebutkan laporan mandiri. Publikasi mengirim entitas sebagaimana ditulis, tidak pernah menulis ulang daftar ini, dan mencatat setiap kapabilitas yang disebutkan laporan mandiri tetapi tidak dicantumkan daftar. Format sumber asing yang diubah importer ini menjadi file penulisan Aggrega berupa draf, masing-masing ditulis sebagai import:<format> — misalnya import:terraform. Prefiks merupakan bagian dari entri, sehingga satu plugin yang mengiklankan beberapa format mencantumkan satu entri per format. Entri mempertahankan urutan penulis. Format impor yang diminta diselesaikan ke importer yang daftarnya berisi entri yang cocok; format yang tidak diiklankan importer mana pun menghentikan impor, dan format yang diiklankan oleh lebih dari satu plugin importer berhenti sebagai ambigu kecuali entri plugins.importer dalam konfigurasi workspace melampirkan salah satunya, yang kemudian dijalankan. Daftar yang kosong atau tidak ada tidak menyatakan klaim format, sehingga plugin tidak mengimpor apa pun.
detectobject[]tidakDikelola mesin, jangan ditulis manual: diturunkan dari laporan mandiri milik .wasm plugin ketika entitas dibuat darinya, dan dicatat di sini dalam urutan yang dinyatakan laporan mandiri tersebut. Tanda tangan yang digunakan untuk mengenali sumber dari format importer ini ketika sebuah impor tidak menyebutkan format. aggrega import membaca tanda tangan setiap importer yang dimuat katalog workspace, termasuk setiap versinya, serta importer inti compiler, mencocokkannya dengan sumber tanpa mengetahui apa format masing-masing, dan membaca sumber sebagai format dari satu-satunya importer yang tanda tangannya cocok; sumber yang tidak cocok dengan tanda tangan mana pun ditolak dengan permintaan format, dan sumber yang cocok dengan tanda tangan lebih dari satu format ditolak dengan menyebutkan format-format tersebut. Importer yang mengenali sebuah sumber mengenalinya sebagai setiap format yang diiklankannya, sehingga importer yang mengiklankan lebih dari satu format membuat setiap kecocokannya ditolak sebagai ambigu. Jika ada, daftar ini harus sama dengan yang dinyatakan laporan mandiri plugin, entri demi entri dan dalam urutan yang sama, dan pemuatan serta publikasi menolak plugin yang laporannya berbeda, dengan menyebutkan field ini. Jika tidak ada, tidak ada klaim yang dibuat dan tidak ada yang dibandingkan, dan format importer tersebut hanya dapat dijangkau dengan menyebutkannya.

Properti tambahan tidak diizinkan.

plugin.spec.importer.detect[]
PropertiJenisWajibDeskripsi
syntaxstringyaFormat sintaksis yang digunakan untuk mengurai sumber — misalnya json atau yaml — yaitu format yang diiklankan plugin parser sebagai parse:<syntax>. Sumber diurai melalui parser yang disediakan katalog workspace untuk sintaksis tersebut, atau, untuk sintaksis yang tidak disediakan parsernya oleh katalog, melalui parser yang dibawa compiler, paling banyak sekali berapa pun jumlah tanda tangan yang menyebutkan sintaksis tersebut, dan sumber yang tidak dapat diurai dengannya tidak cocok dengan tanda tangan mana pun yang menyebutkannya. Sintaksis yang parsernya tidak disediakan oleh keduanya menghentikan pengenalan dengan menyebutkan ketiadaan parser tersebut. Panjang minimal 1 karakter.
filesstring[]tidakPola nama file yang berlaku untuk tanda tangan, dicocokkan dengan akhir nama sumber dengan pemisahnya dibaca sebagai garis miring maju: pola satu segmen dicocokkan dengan nama file itu sendiri, dan pola beberapa segmen yang dipisahkan garis miring dicocokkan dengan sejumlah segmen terakhir yang sama dari path-nya, sehingga .vscode/mcp.json cocok dengan file bernama mcp.json di direktori bernama .vscode. Di dalam satu segmen, * cocok dengan rangkaian karakter apa pun, ? dengan satu karakter, dan [...] dengan satu karakter dari suatu kelas. Tanda tangan berlaku ketika salah satu pola cocok. Jika tidak ada atau kosong, tanda tangan berlaku untuk sumber berupa satu file, apa pun namanya, dan tidak untuk file mana pun dalam direktori. Pola dari tanda tangan sebuah importer juga menentukan file mana dari sebuah direktori yang diserahkan aggrega import kepadanya.
matchobject[]tidakPredikat yang harus dipenuhi pohon hasil penguraian, semuanya, dalam urutan yang dinyatakan. Jika tidak ada atau kosong, tidak ada yang dituntut dari pohon selain dapat diurai dalam sintaksis tersebut.

Properti tambahan tidak diizinkan.

plugin.spec.importer.detect[].match[]
PropertiJenisWajibDeskripsi
pathstringyaTempat di dalam pohon yang diperiksa predikat, ditulis sebagai kunci-kunci yang digabungkan dengan titik dari puncak pohon: data.nodes menunjuk anggota nodes dari objek data tingkat teratas. Segmen yang ditulis sebagai bilangan bulat, 0 atau lebih, memilih posisi tersebut dalam sebuah array dengan hitungan dari nol, sehingga nodes.0.type menunjuk type dari node pertama; setiap segmen lainnya memilih anggota sebuah objek. Panjang minimal 1 karakter.
isstring (enum)yaApa yang harus dicapai path: present terpenuhi ketika path mencapai nilai jenis apa pun, termasuk null; absent terpenuhi ketika path tidak mencapai apa pun; object, array, string, number dan boolean masing-masing terpenuhi ketika path mencapai nilai jenis tersebut. Nilai yang diizinkan: "present", "absent", "object", "array", "string", "number", "boolean"
equalsstringtidakString yang harus sama persis dengan nilai yang dicapai path; nilai yang bukan string tidak pernah sama dengannya. Paling banyak satu dari equals dan prefix dideklarasikan pada satu predikat. Panjang minimal 1 karakter.
prefixstringtidakString yang harus menjadi awalan nilai yang dicapai path; nilai yang bukan string tidak pernah diawali olehnya. Paling banyak satu dari equals dan prefix dideklarasikan pada satu predikat. Panjang minimal 1 karakter.

Properti tambahan tidak diizinkan.