Схема каталогу Aggrega (MappingLibrary)
Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.
Ідентифікатор схеми: https://aggrega.ai/schemas/mappinglibrary-v1beta1.schema.json
Багаторазова колекція фрагментів шаблонів Go, які сутності Recipes і FeatureRecipes використовують під час рендерингу через valuesMapping: { $import: ... }. Рівень 3 — вмикається за бажанням для каталогів, яким потрібне повторне використання зіставлень між сутностями Recipe. Єдиний режим створення: лише шаблони Go.
Див. довідник зі створення MappingLibrary, де описано, як створювати сутності MappingLibrary; ця сторінка документує структурну схему, яку описує той довідник.
Тип верхнього рівня: object
Властивості
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | так | Константа: "aggrega.ai/v1beta1" |
kind | const “MappingLibrary” | так | Константа: "MappingLibrary" |
metadata | object | так | |
spec | object | так | Вміст сутності MappingLibrary. spec.mappings є обов’язковим і має оголошувати принаймні один запис. spec має additionalProperties: false — паралельні режими створення на рівні оболонки не приймаються. Єдиний режим створення забезпечує однорідний рендеринг сутностей Recipe (скрізь шаблони Go) і позбавляє авторів потреби перемикати моделі обчислення посеред рендерингу під час використання імпортованих фрагментів. |
Додаткові властивості не дозволені.
mappinglibrary.metadata
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
name | string | так | Ідентифікатор бібліотеки у форматі PascalCase. Це ім’я ^[A-Z][A-Za-z0-9]*$. |
version | string | так | Версія бібліотеки за суворим семантичним версіонуванням (наприклад, 1.0.0). Споживач може вказати її як необов’язковий нижній поріг мінімальної версії :<version> у посиланні за простим ім’ям (^(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 | ні | Анотації, оголошені автором. Той самий підхід непрозорих метаданих, що й для міток. |
Додаткові властивості не дозволені.
mappinglibrary.spec
Вміст сутності MappingLibrary. spec.mappings є обов’язковим і має оголошувати принаймні один запис. spec має additionalProperties: false — паралельні режими створення на рівні оболонки не приймаються. Єдиний режим створення забезпечує однорідний рендеринг сутностей Recipe (скрізь шаблони Go) і позбавляє авторів потреби перемикати моделі обчислення посеред рендерингу під час використання імпортованих фрагментів.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
mappings | map of string | так | Іменована мапа багаторазових фрагментів шаблонів Go. Тіло кожного запису непрозоре для валідації оболонки — семантику вмісту обробляє парсер шаблонів Go під час використання. Ключі: ідентифікатор у стилі PascalCase. Ключі записів з’являються в канонічних URL посилань (#/mappings/<name>); обмеження на рівні оболонки не дає ключам не у стилі PascalCase поширюватися екосистемою каталогів. Шаблон: ^[A-Z][A-Za-z0-9]*$. Щонайменше 1 запис. |
Додаткові властивості не дозволені.