Schema socket bước FeatureRecipe-Pipeline Wasm của Aggrega
Tài liệu tham khảo được sinh tự động. Không chỉnh sửa thủ công — hãy sinh lại từ JSON Schema đã xuất bản.
Id của schema: https://aggrega.ai/schemas/wasm-frp-step-v1beta1.schema.json
Các dạng dữ liệu truyền tải mà một socket plugin bước feature-recipe-pipeline tiêu thụ (FRPStepInput) và phát ra (FRPStepOutput). Một bước FRP chạy cho mỗi mục pipeline nội tuyến được khai báo trong một Recipe hoặc FeatureRecipe: host giao cho bước toàn bộ tập tài liệu có khóa, bước chọn các tài liệu mà nó nhắm tới theo nội dung, và trả về các bản vá RFC 6902 định địa chỉ theo khóa cùng với các hiệu ứng phụ và chẩn đoán. Đây là một hợp đồng guest riêng biệt với vai trò label-transform, vốn chạy một lần trên toàn bộ đồ thị topology và trả về các bản vá nhãn không trong suốt. Các kiểu payload Go, Rust và TypeScript được sinh từ schema này vào các gói plugin-ABI, nên ba ngôn ngữ đọc và ghi cùng một dạng dữ liệu truyền tải; một guest nhập chúng từ các gói đó, hoặc thông qua bộ kit plugin của nó nếu bộ kit tái xuất chúng.
Một trong các dạng sau
FRPStepInputFRPStepOutput
Định nghĩa
FRPStepInput
Payload mà một guest feature-recipe-pipeline nhận được cho một bước pipeline: tập tài liệu có khóa mà host chuyển giao nguyên vẹn, đầu vào cục bộ của bước mà Recipe đã khai báo cho bước này, ngữ cảnh lúc render, vị trí của bước trong pipeline, và bản ghi các bước đã chạy trước đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
documents | DocumentSet | có | Tập các đơn vị có thể định địa chỉ, có khóa và có gốc theo phạm vi, mà một guest pipeline nhận làm bề mặt đầu vào. Host chuyển giao toàn bộ tập và không diễn giải nội dung của nó; guest chọn các tài liệu mà nó nhắm tới theo nội dung và định địa chỉ các patch của mình theo khóa. |
step_input | object | không | Khối with đã render của bước, một tập khóa theo thứ tự của tác giả mà guest đọc làm đầu vào cục bộ của bước. Giữ nguyên thứ tự của tác giả để payload giống hệt nhau từng byte qua các lần chạy với cùng đầu vào. |
context | object | có | Ngữ cảnh thời điểm render mà host trao cho bước, được mang dưới dạng các byte của tài liệu JSON của nó; schema này không khai báo đối tượng đó, và host không đọc lại gì từ nó. Một bước của một Recipe hoặc của một FeatureRecipe phạm vi component nhận parameters, các giá trị tham số của Release được sắp xếp theo tên và vắng mặt khi không có; annotations, các annotation của node được chia theo nơi mỗi annotation được viết thành aggregate, release và catalog, mỗi phần vắng mặt khi rỗng; và boundary, ranh giới chứa node: name, path (các đoạn của nó), sync_wave (vắng mặt khi bằng 0), directory, sub_directory (vắng mặt khi không có) và annotations (tập mà các ranh giới của Release truyền xuống node, với tập của mục Release riêng của nó được xếp lớp sau cùng; vắng mặt khi rỗng). Một bước của một FeatureRecipe phạm vi ranh giới, vốn không có component host, nhận parameters; annotations chỉ mang nhóm release, tức tập annotation riêng của ranh giới; và một boundary mang name, path của nó và chính tập đó làm annotations. Lần render của provider cho cùng FeatureRecipe đó nhận cùng ngữ cảnh. Độ rộng thụt lề, yaml_indent, không được đặt cho một bước. |
step_index | integer | có | Vị trí của bước này trong pipeline, bắt đầu từ 0. |
preceding_steps | PrecedingStep[] | không | Các bước pipeline đã chạy trước bước này, để guest có thể xem những gì đã diễn ra trước nó. |
Không cho phép thuộc tính bổ sung.
FRPStepOutput
Payload mà một guest feature-recipe-pipeline trả về cho một bước pipeline: các patch RFC 6902 mà host áp dụng lên tập tài liệu có khóa, các tác dụng phụ mà bước này tạo ra, và mọi chẩn đoán mà guest đưa ra.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
patches | JSONPatchOp[] | không | Các thao tác RFC 6902 có cấu trúc mà bước phát ra đối với các tài liệu trong tập có khóa. Mỗi thao tác nêu tài liệu đích theo phạm vi và khóa, rồi nêu rõ op, path và value. Khác với danh sách patch mờ của vai trò label-transform: các patch của một bước FRP được host áp dụng và được khôi phục bằng snapshot khi bước thất bại, nên ở đây các thao tác được nêu rõ thay vì mờ. |
side_effects | SideEffect[] | không | Các tác dụng mà bước này tạo ra ngoài việc patch một tài liệu có sẵn (ví dụ phát ra một CRD hoặc ghi một tệp). |
diagnostics | Diagnostic[] | không | Các chẩn đoán mà guest đưa ra. Mỗi phần tử có cấu trúc chẩn đoán dùng chung của Wasm-plugin. |
outputs | object | không | Các đầu ra có thể định địa chỉ mà guest trả về cho bước này, một tập khóa theo thứ tự của tác giả, điền vào các đầu ra của bước để một bước sau hoặc một template đọc. Giữ nguyên thứ tự của tác giả để payload giống hệt nhau từng byte qua các lần chạy với cùng đầu vào. Vắng mặt khi bước không trả về đầu ra nào. |
error | string | không | Một thông điệp lỗi được đặt khi guest đã chạy nhưng không thể hoàn tất thao tác; vắng mặt khi thành công. Nó khác với mọi chẩn đoán mà đầu ra mang theo: chẩn đoán báo cáo các vấn đề phát hiện trong một lần chạy vẫn tạo ra kết quả, còn error báo cáo rằng bản thân thao tác đã không hoàn tất. Host hiển thị một error có mặt như một lần gọi plugin thất bại. |
Không cho phép thuộc tính bổ sung.
DocumentSet
Tập các đơn vị có thể định địa chỉ, có khóa và có gốc theo phạm vi, mà một guest pipeline nhận làm bề mặt đầu vào. Host chuyển giao toàn bộ tập và không diễn giải nội dung của nó; guest chọn các tài liệu mà nó nhắm tới theo nội dung và định địa chỉ các patch của mình theo khóa.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
own | map của Unit | có | Đầu ra đã render của chính node, có khóa theo token của đơn vị. Giữ nguyên thứ tự khóa để tập đến wire theo thứ tự ổn định và payload giống hệt nhau từng byte qua các lần chạy với cùng đầu vào. |
host | map của Unit | không | Đầu ra đã render của component mà một FeatureRecipe phạm vi component được gắn vào — bề mặt xuyên thực thể. Vắng mặt đối với các bước Recipe và các bước FeatureRecipe phạm vi boundary, vốn không có component chủ. Giữ nguyên thứ tự khóa để tập đến wire theo thứ tự ổn định và payload giống hệt nhau từng byte qua các lần chạy với cùng đầu vào. |
Không cho phép thuộc tính bổ sung.
Unit
Một phần có thể định địa chỉ mà đầu ra do một provider phát ra được chia thành — góc nhìn lai của một phần đầu ra. Một đơn vị có cấu trúc mang một cây (một góc nhìn có thể định địa chỉ theo RFC-6902) và là đích PATCH; một đơn vị mờ chỉ mang media type và các byte của nó (không có cây) và là đích SELECT và EMIT nhưng không phải đích PATCH.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
token | string | có | Địa chỉ vị trí mờ mà codec gán — tên tệp được phát ra đối với tệp một tài liệu, hoặc <filename>#<ordinal> (thứ tự trong tệp) khi một tệp chứa nhiều tài liệu. Guest coi nó là mờ: nó chọn một đơn vị theo nội dung và lặp lại token, không bao giờ phân tích nó. |
bytes | string | không | Các byte gốc của đơn vị, nguồn để ráp lại. Việc ráp lại trung thành từng byte theo cách xây dựng: các byte không bị động đến được nối lại nguyên văn từ đây. Mỗi kit mang chúng trong kiểu trường riêng của nó — dạng thô khi kiểu đó là kiểu byte, mã hóa base64 khi đó là một string mà bước giải mã để khôi phục chúng — và bộ mã hóa được sinh ra chuyển đổi giữa trường và dạng mà wire dùng để mang byte. |
media_type | string | không | Content type của đơn vị (ví dụ application/yaml cho codec YAML mặc định), để guest biết nó đang xem gì. |
tree | any | không | Góc nhìn chuẩn hóa có thể định địa chỉ theo RFC-6902 của đơn vị khi codec tạo ra nó, hoặc vắng mặt khi codec không tạo ra. Một đơn vị có cây là có cấu trúc (một đích PATCH); một đơn vị không có cây là mờ. Tài liệu là mờ đối với host, vốn chuyển các byte đi qua mà không diễn giải chúng, nên ở tầng schema này cây mang bất kỳ giá trị JSON nào. |
Không cho phép thuộc tính bổ sung.
JSONPatchOp
Một thao tác JSON-Patch RFC 6902 mà một bước FRP phát ra đối với một tài liệu trong tập có khóa. Scope và key nêu tài liệu đích; op, path, value và from mang thao tác đối với một vị trí trong tài liệu đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
scope | string (enum) | có | Gốc tài liệu mà thao tác nhắm tới: own (các tài liệu đã render của chính node) hoặc host (các tài liệu của component mà một FeatureRecipe phạm vi component được gắn vào). Giá trị cho phép: "own", "host" |
key | string | có | Khóa tên tệp được phát ra trong gốc đã nêu — khóa mà guest biết được lúc chạy từ tài liệu nó đã chọn theo nội dung. |
op | string | có | Thao tác RFC 6902: một trong add, remove, replace, move, copy, test. |
path | string | có | Một JSON Pointer RFC 6901 trỏ tới vị trí đích trong tài liệu đã nêu. |
value | any | không | Toán hạng cho add, replace và test, bị bỏ qua trong các trường hợp khác. Một đoạn tài liệu JSON tùy ý do guest tạo, mà host chuyển đi qua một cách mờ; ở tầng schema này nó mang bất kỳ giá trị JSON nào. |
from | string | không | Con trỏ nguồn cho move và copy, bị bỏ qua trong các trường hợp khác. |
Không cho phép thuộc tính bổ sung.
SideEffect
Một tác dụng mà một bước feature-recipe-pipeline tạo ra ngoài việc patch một tài liệu có sẵn. Kind là emit_crd hoặc emit_file; schema để nó là một string mở để có thể thêm một loại mới mà không phá vỡ ABI, và bản build dừng lại với bất kỳ loại nào khác. Khi kind là emit_crd, crd mang tài liệu CRD và file bị bỏ qua; khi kind là emit_file, file mang tệp cần ghi và crd bị bỏ qua.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | string | có | Loại tác dụng: emit_crd hoặc emit_file. Schema để trường này là một string mở để có thể thêm một loại mới mà không phá vỡ ABI; bản build dừng lại với bất kỳ loại nào khác, kèm nêu tên node, tác dụng phụ và loại đó. |
scope | string (enum) | không | Gốc tài liệu mà việc phát ra đóng góp vào: own (tập của chính node) hoặc host (tập của component chủ được gắn vào). Một scope vắng mặt nghĩa là own lúc áp dụng. Giá trị cho phép: "own", "host" |
crd | any | không | Tài liệu CRD mà bước phát ra khi kind là emit_crd. Mờ đối với host, vốn chuyển nó đi qua mà không diễn giải; ở tầng schema này nó mang bất kỳ giá trị JSON nào. |
file | SideEffectFile | không | Tệp mà một tác dụng phụ emit_file ghi: đường dẫn đích và nội dung tệp. |
Không cho phép thuộc tính bổ sung.
SideEffectFile
Tệp mà một tác dụng phụ emit_file ghi: đường dẫn đích và nội dung tệp.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
path | string | có | Đường dẫn đích mà tệp được ghi vào. |
content | string | có | Nội dung tệp cần ghi. |
Không cho phép thuộc tính bổ sung.
PrecedingStep
Một bước pipeline đã chạy trước bước hiện tại, để guest có thể xem xét những gì đã diễn ra trước nó: chỉ số của bước trong pipeline, plugin mà bước đó nêu tên, và các tác dụng phụ mà bước đó đã phát ra.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
index | integer | có | Vị trí của bước trước đó trong pipeline, tính từ 0. |
plugin_uri | string | có | Plugin mà mục pipeline trước đó nêu trong trường plugin của nó, đúng như đã viết. |
side_effects | SideEffect[] | không | Các tác dụng phụ mà bước trước đó đã phát ra. |
Không cho phép thuộc tính bổ sung.