Lược đồ Aggrega Catalog (MappingLibrary)
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 lược đồ: https://aggrega.ai/schemas/mappinglibrary-v1beta1.schema.json
Một tập hợp có thể tái sử dụng gồm các đoạn Go template mà các Recipes và FeatureRecipes sử dụng tại thời điểm render thông qua valuesMapping: { $import: ... }. Tầng 3 — tùy chọn tham gia dành cho các catalog cần tái sử dụng ánh xạ giữa các Recipe. Chỉ một chế độ soạn thảo: chỉ Go template.
Xem tài liệu tham khảo soạn thảo MappingLibrary để có hướng dẫn chi tiết về cách soạn thảo các thực thể MappingLibrary; trang này mô tả lược đồ cấu trúc mà tài liệu tham khảo đó trình bày.
Kiểu cấp cao nhất: object
Thuộc tính
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | có | Hằng số: "aggrega.ai/v1beta1" |
kind | const “MappingLibrary” | có | Hằng số: "MappingLibrary" |
metadata | object | có | |
spec | object | có | Nội dung của MappingLibrary. spec.mappings là bắt buộc và phải khai báo ít nhất một mục. spec mang additionalProperties: false — không chấp nhận chế độ soạn thảo song song nào ở cấp phong bì. Lập trường chỉ một chế độ soạn thảo giữ cho việc render Recipe đồng nhất (Go template xuyên suốt) và tránh buộc tác giả phải chuyển đổi mô hình đánh giá giữa chừng khi render lúc sử dụng các đoạn được import. |
Không cho phép thuộc tính bổ sung.
mappinglibrary.metadata
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Định danh PascalCase cho thư viện. Đây là tên ^[A-Z][A-Za-z0-9]*$. |
version | string | có | Phiên bản theo Semantic Versioning nghiêm ngặt của thư viện (ví dụ: 1.0.0). Bên sử dụng có thể khẳng định giá trị này như một ngưỡng phiên bản tối thiểu :<version> tùy chọn trong tham chiếu theo tên trần (^(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 | không | Bản tóm tắt ngắn gọn về phạm vi của thư viện. |
labels | map của string | không | Các nhãn do tác giả khai báo. Trình biên dịch trung lập về nội dung và không diễn giải giá trị nhãn: chúng là metadata không trong suốt, được mang theo để bất cứ thứ gì đọc thư viện dùng làm căn cứ so khớp. |
annotations | map của string | không | Các chú thích do tác giả khai báo. Cùng lập trường siêu dữ liệu không trong suốt như nhãn. |
Không cho phép thuộc tính bổ sung.
mappinglibrary.spec
Nội dung của MappingLibrary. spec.mappings là bắt buộc và phải khai báo ít nhất một mục. spec mang additionalProperties: false — không chấp nhận chế độ soạn thảo song song nào ở cấp phong bì. Lập trường chỉ một chế độ soạn thảo giữ cho việc render Recipe đồng nhất (Go template xuyên suốt) và tránh buộc tác giả phải chuyển đổi mô hình đánh giá giữa chừng khi render lúc sử dụng các đoạn được import.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
mappings | map của string | có | Map có tên gồm các đoạn Go template có thể tái sử dụng. Phần thân của mỗi mục là không trong suốt đối với việc xác thực phong bì — ngữ nghĩa nội dung được trình phân tích Go template xử lý tại thời điểm sử dụng. Khóa: định danh PascalCase. Các khóa mục xuất hiện trong các URL tham chiếu chuẩn (#/mappings/<name>); ràng buộc ở cấp phong bì ngăn các khóa không theo PascalCase lan truyền khắp hệ sinh thái catalog. Mẫu: ^[A-Z][A-Za-z0-9]*$. Ít nhất 1 mục. |
Không cho phép thuộc tính bổ sung.