Схема Aggrega Catalog (SchemaLibrary)
Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.
Ідентифікатор схеми: https://aggrega.ai/schemas/schemalibrary-v1beta1.schema.json
Багаторазово використовувана колекція визначень JSON Schema 2020-12, на які вміст каталогу (Components, Features тощо) може посилатися через $ref за допомогою ідентифікаційного посилання за простим ім’ям
Див. довідник з написання SchemaLibrary, де описано, як писати сутності SchemaLibrary; ця сторінка документує структурну схему, яку описує той довідник.
Тип верхнього рівня: object
Властивості
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | так | Константа: "aggrega.ai/v1beta1" |
kind | const “SchemaLibrary” | так | Константа: "SchemaLibrary" |
metadata | object | так | |
spec | object | так | Вміст сутності SchemaLibrary. spec.schemas є обов’язковим і має оголошувати принаймні один запис; spec.templates є необов’язковим і присутній лише тоді, коли бібліотека використовує параметризовані допоміжні шаблони. |
Додаткові властивості не дозволені.
schemalibrary.metadata
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
name | string | так | Ідентифікатор бібліотеки у стилі PascalCase. Це ім’я ^[A-Z][A-Za-z0-9]*$. |
version | string | так | Сувора семантична версія бібліотеки (наприклад, 1.0.0). Lockfile кожного Release закріплює одну версію кожної бібліотеки. Шаблон: ^(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 | ні | Стислий опис того, що охоплює бібліотека. |
labels | map of string | ні | Мітки, оголошені автором. Компілятор нейтральний щодо вмісту й не інтерпретує значення міток: це непрозорі метадані, які переносяться для того, хто читає бібліотеку, щоб зіставляти за ними. |
annotations | map of string | ні | Анотації, оголошені автором. Той самий підхід непрозорих метаданих, що й для міток. |
Додаткові властивості не дозволені.
schemalibrary.spec
Вміст сутності SchemaLibrary. spec.schemas є обов’язковим і має оголошувати принаймні один запис; spec.templates є необов’язковим і присутній лише тоді, коли бібліотека використовує параметризовані допоміжні шаблони.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
schemas | map of object | так | Іменована мапа багаторазово використовуваних визначень схем. Вміст кожного запису перевіряє компілятор компактної форми під час розбору; перевірка на рівні оболонки перевіряє лише структурну обгортку. Ключі: ідентифікатор у стилі PascalCase — ^[A-Z][A-Za-z0-9]*$. Ключі записів з’являються в ідентифікаційних посиланнях за простим ім’ям (<Library>#/schemas/<name>); обмеження на рівні оболонки не дає ключам не у стилі PascalCase поширюватися екосистемою каталогів. Щонайменше 1 запис. |
templates | map of object | ні | Необов’язкова іменована мапа параметризованих допоміжних шаблонів. Записи схем посилаються на шаблони за іменем через $instantiate:; лише буквальна підстановка скалярних значень — без вбудованих шаблонів Go, без умов, без циклів. Шар підстановки бібліотеки навмисно вужчий за повне обчислення шаблонів, щоб написання залишалося в мові схем, а не вводило окремий механізм шаблонізації. Ключі: ідентифікатор у стилі PascalCase — ^[A-Z][A-Za-z0-9]*$. Та сама дисципліна на рівні оболонки, що й для ключів записів схем; на імена шаблонів посилаються через $instantiate: під час інстанціювання. |
Додаткові властивості не дозволені.