Перейти до вмісту
AggregaAggrega
Обрати мову: Українська
Цю сторінку перекладено машинним способом. Читати оригінал англійською.

Схема Aggrega Catalog (SchemaLibrary)

Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.

Ідентифікатор схеми: https://aggrega.ai/schemas/schemalibrary-v1beta1.schema.json

Багаторазово використовувана колекція визначень JSON Schema 2020-12, на які вміст каталогу (Components, Features тощо) може посилатися через $ref за допомогою ідентифікаційного посилання за простим ім’ям #/schemas/ (версію надає lockfile кожного Release; хост реєстру в посиланні не з’являється). Рівень 3 — вмикається за бажанням для каталогів, яким потрібне повторне використання схем між Component.

Див. довідник з написання SchemaLibrary, де описано, як писати сутності SchemaLibrary; ця сторінка документує структурну схему, яку описує той довідник.

Тип верхнього рівня: object

Властивості

ВластивістьТипОбов’язковаОпис
apiVersionconst “aggrega.ai/v1beta1”такКонстанта: "aggrega.ai/v1beta1"
kindconst “SchemaLibrary”такКонстанта: "SchemaLibrary"
metadataobjectтак
specobjectтакВміст сутності SchemaLibrary. spec.schemas є обов’язковим і має оголошувати принаймні один запис; spec.templates є необов’язковим і присутній лише тоді, коли бібліотека використовує параметризовані допоміжні шаблони.

Додаткові властивості не дозволені.

schemalibrary.metadata

ВластивістьТипОбов’язковаОпис
namestringтакІдентифікатор бібліотеки у стилі PascalCase. Це ім’я в ідентифікаційному посиланні за простим ім’ям #/schemas/; версію надає lockfile кожного Release, і хост реєстру не входить ні в посилання, ні в жоден похідний ідентифікатор. Шаблон: ^[A-Z][A-Za-z0-9]*$.
versionstringтакСувора семантична версія бібліотеки (наприклад, 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-]+)*))?$.
descriptionstringніСтислий опис того, що охоплює бібліотека.
labelsmap of stringніМітки, оголошені автором. Компілятор нейтральний щодо вмісту й не інтерпретує значення міток: це непрозорі метадані, які переносяться для того, хто читає бібліотеку, щоб зіставляти за ними.
annotationsmap of stringніАнотації, оголошені автором. Той самий підхід непрозорих метаданих, що й для міток.

Додаткові властивості не дозволені.

schemalibrary.spec

Вміст сутності SchemaLibrary. spec.schemas є обов’язковим і має оголошувати принаймні один запис; spec.templates є необов’язковим і присутній лише тоді, коли бібліотека використовує параметризовані допоміжні шаблони.

ВластивістьТипОбов’язковаОпис
schemasmap of objectтакІменована мапа багаторазово використовуваних визначень схем. Вміст кожного запису перевіряє компілятор компактної форми під час розбору; перевірка на рівні оболонки перевіряє лише структурну обгортку. Ключі: ідентифікатор у стилі PascalCase — ^[A-Z][A-Za-z0-9]*$. Ключі записів з’являються в ідентифікаційних посиланнях за простим ім’ям (<Library>#/schemas/<name>); обмеження на рівні оболонки не дає ключам не у стилі PascalCase поширюватися екосистемою каталогів. Щонайменше 1 запис.
templatesmap of objectніНеобов’язкова іменована мапа параметризованих допоміжних шаблонів. Записи схем посилаються на шаблони за іменем через $instantiate:; лише буквальна підстановка скалярних значень — без вбудованих шаблонів Go, без умов, без циклів. Шар підстановки бібліотеки навмисно вужчий за повне обчислення шаблонів, щоб написання залишалося в мові схем, а не вводило окремий механізм шаблонізації. Ключі: ідентифікатор у стилі PascalCase — ^[A-Z][A-Za-z0-9]*$. Та сама дисципліна на рівні оболонки, що й для ключів записів схем; на імена шаблонів посилаються через $instantiate: під час інстанціювання.

Додаткові властивості не дозволені.