Схема Aggrega Developer Intent (Aggregate)
Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.
Ідентифікатор схеми: https://aggrega.ai/schemas/aggregate-v1beta1.schema.json
Рекурсивна параметризована архітектура ШІ. Виконує роль і кореня збирання, і модуля для повторного використання.
Описові настанови щодо створення сутностей Aggregate див. у довіднику зі створення сутностей Aggregate; ця сторінка документує структурну схему, яку описує той довідник.
Тип верхнього рівня: object
Властивості
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | так | Константа: "aggrega.ai/v1beta1" |
kind | const “Aggregate” | так | Константа: "Aggregate" |
metadata | object | так | |
defs | string[] | ні | Необов’язковий блок для стандартних якорів YAML (& та *), що дає змогу уникати повторів у сутності Aggregate і водночас зберігати для компілятора плаский словник O(1). Відповідає аналогічному блоку в сутності Manifest. |
spec | object | так | Поверхня наміру розробника: глобальний контракт параметрів, вкладені імпорти агрегатів, публічний API експортованих компонентів, групування в підсистеми та екземпляри компонентів, з яких складається модуль. |
Додаткові властивості не дозволені.
aggregate.metadata
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
name | string | так | Щонайменше 1 символ. |
version | string | так | Строга семантична версія модуля aggregate. Шаблон: ^(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 | ні | |
maintainers | object[] | ні | Список супровідників, яким належить ця сутність. |
license | string | ні | Ідентифікатор SPDX ліцензії програмного забезпечення, яке описує ця сутність, наприклад MIT або AGPL-3.0. Він фіксує умови цього програмного забезпечення, а не умови цього файлу. |
repository | string | ні | URL репозиторію Git, де зберігаються вихідні файли. |
home | string | ні | URL домашньої сторінки, вікі або документації цієї сутності. |
keywords | string[] | ні | Список описових ключових слів для зручного пошуку в інтерфейсі. |
labels | map of string | ні | Мітки качиної типізації на рівні модуля для пошуку в каталозі, оцінювання політик і фільтрування в Studio/IDE. Ці мітки описують ідентичність сутності Aggregate як повторно використовуваного модуля (наприклад, aggregate.aggrega.ai/tier: infrastructure, aggregate.aggrega.ai/compliance: pci-dss). Вони НЕ поширюються на дочірні вузли компонентів — мітки компонентів беруться виключно з каталожної сутності Component у домені 2. |
Додаткові властивості не дозволені.
aggregate.metadata.maintainers[]
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
name | string | так | |
email | string | ні | |
url | string | ні |
Додаткові властивості не дозволені.
aggregate.spec
Поверхня наміру розробника: глобальний контракт параметрів, вкладені імпорти агрегатів, публічний API експортованих компонентів, групування в підсистеми та екземпляри компонентів, з яких складається модуль.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
parameters | map of object | ні | Глобальний контракт середовища. Кожен запис — це об’єкт типізованого контракту, що використовує підмножину словника компактної форми (type, description, default, enum, min/max, minLength/maxLength, pattern, format, validate, validateMessage, required, items, valuesType, properties). Вкладена структура виражається через підполе properties: типізованої форми. Виконання в сутності Release може бути вбудованим (parameters: {…}) або імпортом з одного файлу (parameters: {$import: |
aggregates | map of object | ні | Вкладені агрегати, що діють як імпортовані модулі. Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не дозволена. Шаблон: ^[a-zA-Z0-9_-]+$. |
exportedComponents | map of string | ні | Інтерфейс публічного API. Зіставляє відкрите публічне ім’я з внутрішнім ID компонента. Батьківські сутності Aggregates, що імпортують цей модуль, посилаються на компоненти за цими публічними іменами. |
subsystems | map of subsystem | ні | Іменовані логічні групування компонентів сутності Aggregate у підсистеми. Взаємовиключні з компонентами верхнього рівня — оголошення обох відхиляється. Підсистема, яку автор назвав default, — це звичайна оголошена підсистема, відмінна від синтезованої default, яку компілятор створює для сутності Aggregate лише з компонентами. Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не дозволена. Шаблон: ^[a-zA-Z0-9_-]+$. |
components | map of component_instance | ні | Мапа логічних атомарних компонентів, з яких складається ця сутність Aggregate, задана безпосередньо на верхньому рівні. Компоненти верхнього рівня та підсистеми взаємовиключні — оголошення обох відхиляється. Коли компоненти задано тут (без підсистем), компілятор під час завантаження згортає їх у синтезовану підсистему default, а IR позначає цю підсистему як синтезовану. Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не дозволена. Шаблон: ^[a-zA-Z0-9_-]+$. |
Додаткові властивості не дозволені.
Визначення
inject_delivery
Один механізм доставки, що задається як масив записів. Кожен запис містить ‘in’ (локальний ідентифікатор — ім’я змінної середовища, шлях до файлу, прапорець аргументу або власний ключ, специфічний для механізму) та рівно одне з ‘from’ (ключ provides, який слід розв’язати) або ‘value’ (літеральний рядок, що може містити вирази шаблонів Go, які обчислюються під час розв’язання самоін’єкції). ‘from’ розв’язується відносно provides цілі в контексті uses[].inject, відносно provides, які публікує сутність FeatureRecipe підключення, у контексті features.
Тип: object[]
inject_block
Агностична маршрутизація ін’єкцій. Зіставляє локальні змінні з ключами provides цілі (uses[].inject), з ключами provides, які публікує сутність FeatureRecipe підключення (features.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
env | inject_delivery | ні | Один механізм доставки, що задається як масив записів. Кожен запис містить ‘in’ (локальний ідентифікатор — ім’я змінної середовища, шлях до файлу, прапорець аргументу або власний ключ, специфічний для механізму) та рівно одне з ‘from’ (ключ provides, який слід розв’язати) або ‘value’ (літеральний рядок, що може містити вирази шаблонів Go, які обчислюються під час розв’язання самоін’єкції). ‘from’ розв’язується відносно provides цілі в контексті uses[].inject, відносно provides, які публікує сутність FeatureRecipe підключення, у контексті features. |
file | inject_delivery | ні | Один механізм доставки, що задається як масив записів. Кожен запис містить ‘in’ (локальний ідентифікатор — ім’я змінної середовища, шлях до файлу, прапорець аргументу або власний ключ, специфічний для механізму) та рівно одне з ‘from’ (ключ provides, який слід розв’язати) або ‘value’ (літеральний рядок, що може містити вирази шаблонів Go, які обчислюються під час розв’язання самоін’єкції). ‘from’ розв’язується відносно provides цілі в контексті uses[].inject, відносно provides, які публікує сутність FeatureRecipe підключення, у контексті features. |
arg | inject_delivery | ні | Один механізм доставки, що задається як масив записів. Кожен запис містить ‘in’ (локальний ідентифікатор — ім’я змінної середовища, шлях до файлу, прапорець аргументу або власний ключ, специфічний для механізму) та рівно одне з ‘from’ (ключ provides, який слід розв’язати) або ‘value’ (літеральний рядок, що може містити вирази шаблонів Go, які обчислюються під час розв’язання самоін’єкції). ‘from’ розв’язується відносно provides цілі в контексті uses[].inject, відносно provides, які публікує сутність FeatureRecipe підключення, у контексті features. |
component_uses_block
З’єднання, які компонент проводить до компонентів, від яких залежить, згруповані за сокетом. Кожен сокет перелічує свої цілі або називає кожне з’єднання під псевдонімом. З’єднання, назване під псевдонімом, може містити значення розробника для цього з’єднання та вкладення, що заповнюють слоти, оголошені сокетом.
Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$.
Значення мають тип string[] or map of object.
Будь-які інші ключі не допускаються.
feature_uses_block
З’єднання, які проводить приєднана сутність Feature, згруповані за сокетом, який Feature оголошує у своєму usesSchema. Кожен сокет перелічує свої цілі або називає кожне з’єднання під псевдонімом. З’єднання, яке проводить Feature, не має власних вкладень: потрібні йому облікові дані заповнюють слот, який Feature оголошує у власному featuresSchema, і приєднуються поруч із Feature.
Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$.
Значення мають тип string[] or map of object.
Будь-які інші ключі не допускаються.
connection_attachment
Одне вкладення, яке містить з’єднання: сутність Feature, що заповнює слот, оголошений сокетом з’єднання, разом із конфігурацією розробника для неї.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
type | string | так | URI інтерфейсу Feature, який запитує це вкладення (наприклад, core/referenced-secret:1.0.0). |
description | string | ні | Необов’язкова документація, що пояснює, чому це з’єднання містить вкладення. |
values | object | ні | Конфігурація для Feature, надана розробником і перевірена за оголошенням її схеми. |
Додаткові властивості не дозволені.
subsystem
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
description | string | ні | Необов’язкова документація, що описує призначення цієї підсистеми та логічне групування, яке вона представляє. |
annotations | map of string or object or null | ні | Анотації розробника для цієї підсистеми. Значення — рядки, структуровані об’єкти (мапа підключів на значення, що зливається за кожним підключем з успадкованим структурованим значенням) або null; явне null для ключа, успадкованого від батьківської підсистеми, вилучає успадковану прив’язку з цієї підсистеми (відмова від Feature через анотації). Оголошені тут анотації успадковуються вкладеними підсистемами та компонентами, що в ній містяться; для кожного ключа перевагу має ближчий рівень. Каскадно передаються до розділу .context.annotations.aggregate на кожному похідному вузлі IR. |
features | map of object | ні | Наскрізні функції, приєднані до всіх компонентів цієї підсистеми. Та сама схема, що й у функцій рівня компонента (type, values, uses, inject). Під час фіналізації графа розгортаються в кожен компонент і розміщуються після функцій рівня компонента в порядку виконання. Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$. |
subsystems | map of subsystem | ні | Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$. |
components | map of component_instance | ні | Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$. |
Додаткові властивості не дозволені.
component_instance
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
type | string | так | Запитувана абстрактна сутність Component у вигляді посилання: її metadata.name разом із необов’язковою :version (наприклад, core/api-server:1.0.0), ніколи не шлях до файлу. Розв’язується за трирівневою моделлю розв’язання сутностей (каталоги каталогу робочого простору → кеш → реєстр): локально створену сутність Component розміщують у catalog/ у корені робочого простору або в каталозі, указаному в workspace.catalog_dirs, а type, записаний як відносний шлях до файлу, зупиняє збирання як сутність, якої немає в жодному каталозі. |
active | boolean або string | ні | Чи присутній цей компонент у скомпільованій топології. Булеве значення або рядковий шаблон над .parameters, який має розв’язатися в булеве значення. Коли він розв’язується в false, компонент вилучається з топології разом із його ребрами uses і його прикріпленнями. Якщо значення залежить від параметра, сутність Release може вмикати й вимикати присутність компонента, задаючи цей параметр. Якщо пропущено, типово true. Типове значення: true |
description | string | ні | Необов’язкова документація, що описує роль цього екземпляра компонента в застосунку. Переноситься до графа IR. |
annotations | map of string or object or null | ні | Анотації, які розробник задає для цього компонента. Значеннями є рядки, структуровані об’єкти (мапа підключів на значення, що зливається за кожним підключем з успадкованим структурованим значенням) або null; явний null для ключа, успадкованого від батьківської підсистеми, вилучає успадковану прив’язку з цього компонента (відмова від Feature на основі анотацій). Анотації рівня Component перевизначають успадковані анотації рівня підсистеми для кожного ключа окремо; сусідні компоненти в тій самій підсистемі зберігають власні мапи анотацій незалежно. |
values | object | ні | Непрозорі когнітивні властивості, що передаються сутності Component і перевіряються її схемою. |
uses | component_uses_block | ні | З’єднання, які компонент проводить до компонентів, від яких залежить, згруповані за сокетом. Кожен сокет перелічує свої цілі або називає кожне з’єднання під псевдонімом. З’єднання, назване під псевдонімом, може містити значення розробника для цього з’єднання та вкладення, що заповнюють слоти, оголошені сокетом. |
inject | inject_block | ні | Самоін’єкція на рівні компонента. Впроваджує власні значення компонента (через ‘value:’) або власні ключі provides (через ‘from:’) безпосередньо в канал доставки (.context.inject). Дозволено, лише якщо каталожна сутність Component оголошує ‘spec.inject’ з відповідними механізмами. Ключ inject, що збігається з ключем, оголошеним в uses[].inject, зупиняє збирання як дубльований ключ доставки між джерелами inject. |
features | map of object | ні | Сутності Features, прикріплені до цього компонента, з ключами — іменами екземплярів, які автор дає кожному прикріпленню. Це єдина поверхня прикріплення: операційна Feature, Feature облікових даних (з міткою feature.aggrega.ai/kind: secret) і Feature ідентичності прикріплюються тут, з тим самим ключовим словом і тією самою формою. Відрізняється між ними те, що створює прикріплення, а не те, як його оголошено. Прикріплення, ім’я екземпляра якого збігається зі слотом, що його Component оголошує у featuresSchema, заповнює цей слот; будь-яке інше ім’я екземпляра — це вільне прикріплення. Ключі: одна або більше літер, цифр, підкреслень чи дефісів. Крапка не допускається. Шаблон: ^[a-zA-Z0-9_-]+$. |
Додаткові властивості не дозволені.