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

Схема каталогу Aggrega (MappingLibrary)

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

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

Багаторазова колекція фрагментів шаблонів Go, які сутності Recipes і FeatureRecipes використовують під час рендерингу через valuesMapping: { $import: ... }. Рівень 3 — вмикається за бажанням для каталогів, яким потрібне повторне використання зіставлень між сутностями Recipe. Єдиний режим створення: лише шаблони Go.

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

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

Властивості

ВластивістьТипОбов’язковаОпис
apiVersionconst “aggrega.ai/v1beta1”такКонстанта: "aggrega.ai/v1beta1"
kindconst “MappingLibrary”такКонстанта: "MappingLibrary"
metadataobjectтак
specobjectтакВміст сутності MappingLibrary. spec.mappings є обов’язковим і має оголошувати принаймні один запис. spec має additionalProperties: false — паралельні режими створення на рівні оболонки не приймаються. Єдиний режим створення забезпечує однорідний рендеринг сутностей Recipe (скрізь шаблони Go) і позбавляє авторів потреби перемикати моделі обчислення посеред рендерингу під час використання імпортованих фрагментів.

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

mappinglibrary.metadata

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

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

mappinglibrary.spec

Вміст сутності MappingLibrary. spec.mappings є обов’язковим і має оголошувати принаймні один запис. spec має additionalProperties: false — паралельні режими створення на рівні оболонки не приймаються. Єдиний режим створення забезпечує однорідний рендеринг сутностей Recipe (скрізь шаблони Go) і позбавляє авторів потреби перемикати моделі обчислення посеред рендерингу під час використання імпортованих фрагментів.

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

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