Перейти к содержимому
AggregaAggrega
Выберите язык: Русский
Эта страница переведена машинным способом. Читать оригинал на английском.

Схема Aggrega Catalog (SchemaLibrary)

Сгенерированный справочник. Не редактируйте вручную — сгенерируйте заново из опубликованной JSON Schema.

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

Повторно используемый набор определений JSON Schema 2020-12, на которые содержимое каталога (Components, Features и т. д.) может ссылаться через $ref с помощью идентификационной ссылки по простому имени #/schemas/ (версия задаётся lock-файлом каждой сущности 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/; версия задаётся lock-файлом каждой сущности Release, а хост реестра не входит ни в ссылку, ни в какой-либо производный идентификатор. Шаблон: ^[A-Z][A-Za-z0-9]*$.
versionstringдаСтрогая семантическая версия библиотеки (например, 1.0.0). Lock-файл каждой сущности 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: во время инстанцирования.

Дополнительные свойства не допускаются.