Schema của Aggrega Wasm Mutator Socket
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.
Schema id: https://aggrega.ai/schemas/wasm-mutator-v1beta1.schema.json
Các dạng dữ liệu truyền mà một plugin quản trị gắn ở vai trò label-transform tiêu thụ (MutatorInput) và phát ra (MutatorOutput). Vai trò này chạy khi dựng topology, sau khi đồ thị được dựng và trước khi nó được phán xét: plugin trả về các tài liệu JSON Patch, và host áp dụng chúng lên nhãn của các node và không lên gì khác, dừng bản build khi gặp một patch chạm tới bất kỳ phần nào khác của đồ thị. 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; 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
MutatorInputMutatorOutput
Định nghĩa
MutatorInput
Payload mà host trao cho plugin mutator ở mỗi lần gọi: ngữ cảnh biên dịch ở cấp release cùng với một phép chiếu của đồ thị topology mang nhãn của mỗi node và các giá trị mà instance của nó khai báo.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
compilation_context | CompilationContext | có | Siêu dữ liệu cấp Release mà mutator đọc khi quyết định những quy tắc tuân thủ, FinOps hoặc quản trị nào áp dụng cho bản build. |
graph | MutatorGraph | có | Phép chiếu của đồ thị topology được cung cấp cho plugin mutator: Component của mỗi node, phiên bản đã phân giải của nó, các nhãn của nó và các giá trị mà instance của nó khai báo. Được cố ý thu hẹp hơn kết quả topology đầy đủ: các cạnh và payload của feature không được cung cấp vì nhiệm vụ của mutator là gắn nhãn, không phải định hình lại topology. Các giá trị có ở đó để được đọc, để một cấu hình mà nhà phát triển đã khai báo có thể quyết định một nhãn; một patch chỉ chạm tới nhãn và không gì khác, nên plugin không thể thay đổi các giá trị. |
sources | MutatorSource[] | không | Các tệp định nghĩa mà host đọc và trao nguyên văn cho plugin, dưới dạng một danh sách có thứ tự được sắp xếp theo đường dẫn. Host đọc các byte như nội dung mờ và không phân tích chúng. Vắng mặt khi phần gắn không khai báo nguồn nào. |
settings | object | không | Một đối tượng thiết lập dạng tự do mà host trao nguyên văn cho plugin. Host không phân tích hay xử lý nội dung của nó. Vắng mặt khi phần gắn không khai báo thiết lập nào. |
Không cho phép thuộc tính bổ sung.
MutatorOutput
Dạng phản hồi mà plugin mutator phát ra: một danh sách các tài liệu JSON Patch mờ mà host áp dụng lên đồ thị topology. Các patch được giữ mờ ở tầng schema để host không cần sao chép bộ phân tích JSON Patch mà guest đã triển khai.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
patches | any[] | có | Các tài liệu JSON Patch mờ cần áp dụng lên đồ thị topology, theo thứ tự. |
error | string | không | 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. Host thể hiện một error có mặt dưới dạng một lần gọi plugin thất bại. |
Không cho phép thuộc tính bổ sung.
CompilationContext
Siêu dữ liệu cấp Release mà mutator đọc khi quyết định những quy tắc tuân thủ, FinOps hoặc quản trị nào áp dụng cho bản build.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
release_name | string | có | metadata.name của Release. |
environment | string | có | Nhãn môi trường mà Release chạy trong đó (ví dụ: dev, staging, prod). |
Không cho phép thuộc tính bổ sung.
MutatorGraph
Phép chiếu của đồ thị topology được cung cấp cho plugin mutator: Component của mỗi node, phiên bản đã phân giải của nó, các nhãn của nó và các giá trị mà instance của nó khai báo. Được cố ý thu hẹp hơn kết quả topology đầy đủ: các cạnh và payload của feature không được cung cấp vì nhiệm vụ của mutator là gắn nhãn, không phải định hình lại topology. Các giá trị có ở đó để được đọc, để một cấu hình mà nhà phát triển đã khai báo có thể quyết định một nhãn; một patch chỉ chạm tới nhãn và không gì khác, nên plugin không thể thay đổi các giá trị.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
nodes | map của MutatorNode | có | Các node được đánh khóa theo ID node tuyệt đối. |
Không cho phép thuộc tính bổ sung.
MutatorNode
Phép chiếu cho mỗi node mà plugin mutator dùng để đánh giá các quy tắc của nó: node triển khai Component nào, phiên bản nào của Component đó đã được phân giải, node mang những nhãn nào, và instance của nó khai báo những giá trị nào.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
component | string | có | Tên của Component nền tảng mà node khởi tạo. |
resolved_version | string | có | Phiên bản Semantic Version chính xác của Component mà bộ phân giải đã ghim cho node này. |
labels | map của string | có | Các nhãn duck-typing và ontology của node. |
values | object | không | Các giá trị mà instance component của node khai báo trong Aggregate, được khóa như tác giả đã viết và theo thứ tự của tác giả. Mọi template trong Aggregate đã được đánh giá theo các tham số của nó, nên một giá trị được đưa lên thành tham số sẽ đến dưới dạng giá trị mà Release cung cấp, hoặc dưới dạng giá trị mặc định của tham số. Chỉ có các giá trị riêng của instance ở đây: giá trị mặc định mà schema của Component khai báo, và bất cứ thứ gì một Recipe hoặc một Feature đóng góp, đều không có. Một giá trị mà Component khai báo là nhạy cảm sẽ đến ở dạng bị giữ lại, đúng như cách phán quyết quản trị trên toàn bộ đồ thị nhận nó: ở vị trí của nó là cùng đối tượng đánh dấu giữ lại một khóa mà phán quyết đó mang, nêu lý do đã khai báo, còn một giá trị anh em mà không khai báo nào chạm tới sẽ đến đúng như đã viết. Một plugin đọc chúng để quyết định thêm những nhãn nào; một patch không thể chạm tới chúng. Vắng mặt khi instance không khai báo giá trị nào. |
Không cho phép thuộc tính bổ sung.
MutatorSource
Một tệp định nghĩa được trao cho plugin: đường dẫn tên cơ sở và nội dung của tệp. Cả hai được truyền nguyên văn; host không phân tích nội dung.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
path | string | có | Tên cơ sở của tệp nguồn. Host chỉ cung cấp tên cơ sở, không bao giờ là một đường dẫn tuyệt đối trên host, để dữ liệu truyền có tính di động và tất định. |
content | string | có | Nội dung của tệp nguồn, được truyền nguyên văn dưới dạng một chuỗi mờ. |
Không cho phép thuộc tính bổ sung.