Lược đồ Aggrega Catalog (SchemaLibrary)
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/schemalibrary-v1beta1.schema.json
Một tập hợp có thể tái sử dụng gồm các định nghĩa JSON Schema 2020-12 mà nội dung catalog (Components, Features, v.v.) có thể $ref tới thông qua tham chiếu định danh tên trần
Xem tài liệu tham khảo soạn thảo SchemaLibrary để có hướng dẫn dạng văn xuôi về cách soạn các thực thể SchemaLibrary; trang này mô tả lược đồ cấu trúc mà tài liệu tham khảo đó đề cập.
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 “SchemaLibrary” | có | Hằng số: "SchemaLibrary" |
metadata | object | có | |
spec | object | có | Nội dung của SchemaLibrary. spec.schemas là bắt buộc và phải khai báo ít nhất một mục; spec.templates là tùy chọn và chỉ có mặt khi thư viện dùng các helper có tham số. |
Không cho phép thuộc tính bổ sung.
schemalibrary.metadata
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Định danh PascalCase của 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). Lockfile theo từng Release ghim một phiên bản cho mỗi thư viện. Mẫu: ^(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.
schemalibrary.spec
Nội dung của SchemaLibrary. spec.schemas là bắt buộc và phải khai báo ít nhất một mục; spec.templates là tùy chọn và chỉ có mặt khi thư viện dùng các helper có tham số.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
schemas | map của object | có | Map có tên gồm các định nghĩa lược đồ có thể tái sử dụng. Nội dung của mỗi mục được trình biên dịch dạng rút gọn xác thực tại thời điểm phân tích; việc xác thực ở cấp envelope chỉ kiểm tra lớp bao cấu trúc. Khóa: định danh PascalCase — ^[A-Z][A-Za-z0-9]*$. Khóa của mục xuất hiện trong các tham chiếu định danh tên trần (<Library>#/schemas/<name>); ràng buộc ở cấp envelope ngăn các khóa không theo PascalCase lan truyền trong hệ sinh thái catalog. Ít nhất 1 mục. |
templates | map của object | không | Map có tên tùy chọn gồm các helper có tham số. Các mục lược đồ tham chiếu template theo tên thông qua $instantiate:; chỉ thay thế giá trị vô hướng theo nghĩa đen — không có Go template nhúng, không có điều kiện, không có vòng lặp. Lớp thay thế của thư viện được cố ý giới hạn hẹp hơn so với việc đánh giá template đầy đủ để việc soạn thảo vẫn nằm trong ngôn ngữ lược đồ thay vì tạo ra một bề mặt templating riêng. Khóa: định danh PascalCase — ^[A-Z][A-Za-z0-9]*$. Cùng nguyên tắc ở cấp envelope như khóa của mục lược đồ; tên template được tham chiếu thông qua $instantiate: tại thời điểm khởi tạo. |
Không cho phép thuộc tính bổ sung.