Skema Aggrega Wasm FeatureRecipe-Pipeline Step Socket
Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.
Id skema: https://aggrega.ai/schemas/wasm-frp-step-v1beta1.schema.json
Bentuk wire yang dikonsumsi (FRPStepInput) dan dihasilkan (FRPStepOutput) oleh socket plugin langkah feature-recipe-pipeline. Sebuah langkah FRP dijalankan untuk setiap entri pipeline inline yang dideklarasikan dalam Recipe atau FeatureRecipe: host menyerahkan seluruh set dokumen berkunci kepada langkah tersebut, langkah itu memilih dokumen yang menjadi targetnya berdasarkan konten, lalu mengembalikan patch RFC 6902 yang dialamatkan dengan kunci beserta efek samping dan diagnostik. Ini adalah kontrak guest yang berbeda dari peran label-transform, yang dijalankan satu kali atas seluruh graf topologi dan mengembalikan patch label yang buram. Tipe payload Go, Rust, dan TypeScript dihasilkan dari skema ini ke dalam paket plugin-ABI, sehingga ketiga bahasa membaca dan menulis satu wire yang sama; guest mengimpornya dari paket tersebut, atau melalui kit plugin-nya jika kit tersebut mengekspor ulang tipe-tipe itu.
Salah satu dari bentuk berikut
FRPStepInputFRPStepOutput
Definisi
FRPStepInput
Payload yang diterima guest feature-recipe-pipeline untuk satu langkah pipeline: set dokumen berkunci yang diserahkan host secara utuh, input lokal langkah yang dideklarasikan Recipe untuk langkah ini, konteks waktu render, posisi langkah dalam pipeline, dan catatan langkah-langkah yang sudah dijalankan.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
documents | DocumentSet | ya | Set unit beralamat yang berkunci dan berakar pada scope, yang diterima guest pipeline sebagai permukaan inputnya. Host menyerahkan seluruh set dan tidak menafsirkan kontennya; guest memilih dokumen yang ditargetkannya berdasarkan konten dan mengalamatkan patch-nya berdasarkan kunci. |
step_input | object | tidak | Blok with langkah yang telah dirender, sebuah set kunci berurutan sesuai penulis yang dibaca guest sebagai input lokal langkahnya. Mempertahankan urutan penulis sehingga payload identik per byte di setiap eksekusi dengan input yang identik. |
context | object | ya | Konteks waktu render yang diserahkan host kepada langkah, dibawa sebagai byte dokumen JSON-nya; skema ini tidak mendeklarasikan objek tersebut, dan host tidak membaca apa pun kembali darinya. Langkah dari Recipe atau dari FeatureRecipe berlingkup komponen menerima parameters, yaitu nilai parameter Release yang diurutkan berdasarkan nama dan tidak ada jika tidak ada parameter; annotations, yaitu anotasi node yang dipisahkan berdasarkan tempat masing-masing ditulis menjadi aggregate, release, dan catalog, masing-masing tidak ada jika kosong; dan boundary, yaitu boundary tempat node berada: name, path (segmen-segmennya), sync_wave (tidak ada jika 0), directory, sub_directory (tidak ada jika tidak ada) dan annotations (himpunan yang diturunkan secara berjenjang oleh boundary Release ke node, dengan milik entri Release-nya sendiri dilapiskan terakhir; tidak ada jika kosong). Langkah dari FeatureRecipe berlingkup boundary, yang tidak memiliki komponen host, menerima parameters; annotations yang hanya membawa bucket release, yaitu himpunan anotasi milik boundary itu sendiri; dan boundary yang membawa name, path, serta himpunan yang sama tersebut sebagai annotations. Render provider untuk FeatureRecipe yang sama menerima konteks yang sama. Lebar indentasi, yaml_indent, tidak ditetapkan untuk sebuah langkah. |
step_index | integer | ya | Posisi langkah ini dalam pipeline, berbasis nol. |
preceding_steps | PrecedingStep[] | tidak | Langkah-langkah pipeline yang dijalankan sebelum langkah ini, sehingga guest dapat memeriksa apa yang mendahuluinya. |
Properti tambahan tidak diizinkan.
FRPStepOutput
Payload yang dikembalikan guest feature-recipe-pipeline untuk satu langkah pipeline: patch RFC 6902 yang diterapkan host pada set dokumen berkunci, efek samping yang dihasilkan langkah ini, dan diagnostik apa pun yang dimunculkan guest.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
patches | JSONPatchOp[] | tidak | Operasi RFC 6902 terstruktur yang dikeluarkan langkah terhadap dokumen dalam set berkunci. Masing-masing menyebut dokumen targetnya berdasarkan scope dan kunci, lalu menyebut op, path, dan value secara eksplisit. Berbeda dari daftar patch buram milik peran label-transform: patch langkah FRP diterapkan oleh host dan dipulihkan melalui snapshot pada langkah yang gagal, sehingga operasinya eksplisit di sini alih-alih buram. |
side_effects | SideEffect[] | tidak | Efek yang dihasilkan langkah ini di luar mem-patch dokumen yang sudah ada (misalnya mengeluarkan CRD atau menulis file). |
diagnostics | Diagnostic[] | tidak | Diagnostik yang dimunculkan guest. Setiap elemen berbentuk diagnostik plugin Wasm bersama. |
outputs | object | tidak | Output beralamat yang dikembalikan guest untuk langkah ini, sebuah set kunci berurutan sesuai penulis yang mengisi output langkah untuk dibaca langkah berikutnya atau template. Mempertahankan urutan penulis sehingga payload identik per byte di setiap eksekusi dengan input yang identik. Tidak ada jika langkah tidak mengembalikan output. |
error | string | tidak | Pesan kegagalan yang diisi ketika guest berjalan tetapi tidak dapat menyelesaikan operasi; tidak ada jika berhasil. Ini berbeda dari diagnostik apa pun yang dibawa output: diagnostik melaporkan masalah yang ditemukan selama run yang tetap menghasilkan hasil, sedangkan error melaporkan bahwa operasi itu sendiri tidak selesai. Host menampilkan error yang ada sebagai pemanggilan plugin yang gagal. |
Properti tambahan tidak diizinkan.
DocumentSet
Set unit beralamat yang berkunci dan berakar pada scope, yang diterima guest pipeline sebagai permukaan inputnya. Host menyerahkan seluruh set dan tidak menafsirkan kontennya; guest memilih dokumen yang ditargetkannya berdasarkan konten dan mengalamatkan patch-nya berdasarkan kunci.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
own | map dari Unit | ya | Output hasil render milik node itu sendiri, berkunci token unit. Mempertahankan urutan kunci sehingga set mencapai wire dalam urutan yang stabil dan payload identik per byte di setiap eksekusi dengan input yang identik. |
host | map dari Unit | tidak | Output hasil render dari komponen tempat FeatureRecipe ber-scope komponen dilampirkan — permukaan lintas entitas. Tidak ada untuk langkah Recipe dan langkah FeatureRecipe ber-scope batas, yang tidak memiliki komponen host. Mempertahankan urutan kunci sehingga set mencapai wire dalam urutan yang stabil dan payload identik per byte di setiap eksekusi dengan input yang identik. |
Properti tambahan tidak diizinkan.
Unit
Satu bagian beralamat hasil pemecahan output yang dikeluarkan provider — tampilan hibrida dari satu bagian output. Unit terstruktur membawa pohon (tampilan yang dapat dialamatkan dengan RFC 6902) dan merupakan target PATCH; unit buram hanya membawa jenis media dan byte-nya (tanpa pohon) dan merupakan target SELECT dan EMIT tetapi bukan target PATCH.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
token | string | ya | Alamat posisional buram yang ditetapkan codec — nama file yang dikeluarkan untuk file berdokumen tunggal, atau <filename>#<ordinal> (urutan file) jika satu file membawa beberapa dokumen. Guest memperlakukannya sebagai buram: guest memilih unit berdasarkan konten dan mengembalikan token tersebut, tanpa pernah mem-parse-nya. |
bytes | string | tidak | Byte asli unit, sumber penyusunan ulang. Penyusunan ulang setia per byte secara konstruksi: byte yang tidak tersentuh disambung kembali dari sini apa adanya. Setiap kit membawanya dalam jenis field-nya sendiri — mentah jika jenis tersebut adalah jenis byte, dienkode base64 jika berupa string yang didekode langkah untuk memulihkannya — dan encoder yang dihasilkan mengonversi antara field dan bentuk yang digunakan wire untuk membawa byte. |
media_type | string | tidak | Jenis konten unit (misalnya application/yaml untuk codec YAML bawaan), sehingga guest mengetahui apa yang sedang dilihatnya. |
tree | any | tidak | Tampilan ternormalisasi unit yang dapat dialamatkan dengan RFC 6902 jika codec menghasilkannya, atau tidak ada jika tidak. Unit dengan pohon bersifat terstruktur (target PATCH); unit tanpa pohon bersifat buram. Dokumen bersifat buram bagi host, yang meneruskan byte tanpa menafsirkannya, sehingga pohon dapat membawa nilai JSON apa pun pada lapisan skema ini. |
Properti tambahan tidak diizinkan.
JSONPatchOp
Satu operasi JSON-Patch RFC 6902 yang dikeluarkan langkah FRP terhadap satu dokumen dalam set berkunci. Scope dan key menyebut dokumen target; op, path, value, dan from membawa operasi terhadap suatu lokasi dalam dokumen tersebut.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
scope | string (enum) | ya | Akar dokumen yang ditargetkan operasi: own (dokumen hasil render milik node itu sendiri) atau host (dokumen dari komponen tempat FeatureRecipe ber-scope komponen dilampirkan). Nilai yang diizinkan: "own", "host" |
key | string | ya | Kunci nama file yang dikeluarkan dalam akar yang disebut — kunci yang dipelajari guest saat runtime dari dokumen yang dipilihnya berdasarkan konten. |
op | string | ya | Operasi RFC 6902: salah satu dari add, remove, replace, move, copy, test. |
path | string | ya | JSON Pointer RFC 6901 ke lokasi target dalam dokumen yang disebut. |
value | any | tidak | Operand untuk add, replace, dan test, dihilangkan dalam kasus lain. Fragmen dokumen JSON arbitrer yang ditulis guest, yang diteruskan host secara buram; fragmen ini dapat membawa nilai JSON apa pun pada lapisan skema ini. |
from | string | tidak | Pointer sumber untuk move dan copy, dihilangkan dalam kasus lain. |
Properti tambahan tidak diizinkan.
SideEffect
Satu efek yang dihasilkan langkah feature-recipe-pipeline di luar mem-patch dokumen yang sudah ada. Kind adalah emit_crd atau emit_file; skema membiarkannya sebagai string terbuka sehingga jenis baru dapat ditambahkan tanpa merusak ABI, dan build berhenti pada jenis lain apa pun. Jika kind adalah emit_crd, crd membawa dokumen CRD dan file dihilangkan; jika kind adalah emit_file, file membawa file yang akan ditulis dan crd dihilangkan.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
kind | string | ya | Jenis efek: emit_crd atau emit_file. Skema membiarkan field ini sebagai string terbuka sehingga jenis baru dapat ditambahkan tanpa merusak ABI; build berhenti pada jenis lain apa pun, dengan menyebutkan node, efek samping, dan jenisnya. |
scope | string (enum) | tidak | Akar dokumen yang menerima kontribusi emit: own (set milik node itu sendiri) atau host (set milik komponen host yang dilampiri). Scope yang tidak ada berarti own saat penerapan. Nilai yang diizinkan: "own", "host" |
crd | any | tidak | Dokumen CRD yang dikeluarkan langkah jika kind adalah emit_crd. Buram bagi host, yang meneruskannya tanpa menafsirkannya; dokumen ini dapat membawa nilai JSON apa pun pada lapisan skema ini. |
file | SideEffectFile | tidak | File yang ditulis oleh efek samping emit_file: path target dan konten file. |
Properti tambahan tidak diizinkan.
SideEffectFile
File yang ditulis oleh efek samping emit_file: path target dan konten file.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
path | string | ya | Path target tempat file ditulis. |
content | string | ya | Konten file yang akan ditulis. |
Properti tambahan tidak diizinkan.
PrecedingStep
Satu langkah pipeline yang berjalan sebelum langkah saat ini, sehingga guest dapat memeriksa apa yang terjadi sebelumnya: indeks pipeline langkah tersebut, plugin yang disebutkannya, dan efek samping yang dihasilkan langkah tersebut.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
index | integer | ya | Posisi berbasis nol dari langkah sebelumnya dalam pipeline. |
plugin_uri | string | ya | Plugin yang disebutkan entri pipeline sebelumnya dalam field plugin-nya, sebagaimana ditulis. |
side_effects | SideEffect[] | tidak | Efek samping yang dihasilkan langkah sebelumnya. |
Properti tambahan tidak diizinkan.