Схема Aggrega Catalog (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 | да | Версия библиотеки в строгом формате Semantic Versioning (например, 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 записи. |
Дополнительные свойства не допускаются.