Схема сокета шага Aggrega Wasm FeatureRecipe-Pipeline
Сгенерированный справочник. Не редактируйте вручную — сгенерируйте заново из опубликованной JSON Schema.
Идентификатор схемы: https://aggrega.ai/schemas/wasm-frp-step-v1beta1.schema.json
Формы передаваемых данных, которые сокет плагина шага конвейера рецепта функции принимает (FRPStepInput) и выдаёт (FRPStepOutput). Шаг FRP выполняется для каждой встроенной записи конвейера, объявленной в Recipe или FeatureRecipe: хост передаёт шагу весь набор документов с ключами, шаг выбирает целевые документы по их содержимому и возвращает патчи RFC 6902 с адресацией по ключам, а также побочные эффекты и диагностические сообщения. Это отдельный гостевой контракт, отличный от роли label-transform, которая выполняется один раз над всем графом топологии и возвращает непрозрачные патчи меток. Типы полезной нагрузки для Go, Rust и TypeScript генерируются из этой схемы в пакеты plugin-ABI, поэтому все три языка читают и записывают одни и те же передаваемые данные; гостевой модуль импортирует их из этих пакетов или через свой набор для разработки плагинов, если тот их реэкспортирует.
Одна из следующих форм
FRPStepInputFRPStepOutput
Определения
FRPStepInput
Полезная нагрузка, которую гостевой модуль конвейера feature-recipe получает для одного шага конвейера: набор документов с ключами, который хост передаёт целиком, локальный для шага ввод, объявленный сущностью Recipe для этого шага, контекст времени рендеринга, позиция шага в конвейере и запись уже выполненных шагов.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
documents | DocumentSet | да | Набор адресуемых единиц с ключами и корнями по области, который гостевой модуль конвейера получает в качестве входной поверхности. Хост передаёт весь набор и не интерпретирует его содержимое; гостевой модуль выбирает целевые документы по содержимому и адресует свои патчи по ключу. |
step_input | object | нет | Отрендеренный блок with шага — упорядоченный автором набор ключей, который гостевой модуль читает как локальный для шага ввод. Сохраняет порядок автора, чтобы полезная нагрузка была побайтово идентичной между запусками с одинаковым вводом. |
context | object | да | Контекст времени рендеринга, который хост передаёт шагу, в виде байтов его JSON-документа; эта схема не объявляет этот объект, и хост ничего из него обратно не читает. Шаг сущности Recipe или FeatureRecipe с областью компонента получает parameters — значения параметров Release, отсортированные по имени, отсутствующие, если их нет; annotations — аннотации узла, разделённые по месту записи на aggregate, release и catalog, каждая отсутствует, если пуста; и boundary — границу, в которой находится узел: name, path (его сегменты), sync_wave (отсутствует при 0), directory, sub_directory (отсутствует, если его нет) и annotations (набор, который границы Release каскадно передают узлу, причём аннотации собственной записи Release накладываются последними; отсутствует, если пуст). Шаг сущности FeatureRecipe с областью границы, у которой нет компонента-хоста, получает parameters; annotations, содержащие только корзину release, то есть собственный набор аннотаций границы; и boundary, содержащую её name, path и тот же набор в качестве annotations. Рендеринг провайдером той же сущности FeatureRecipe получает тот же контекст. Ширина отступа, yaml_indent, для шага не задаётся. |
step_index | integer | да | Позиция этого шага в конвейере, отсчитываемая от нуля. |
preceding_steps | PrecedingStep[] | нет | Шаги конвейера, выполненные до этого шага, чтобы гостевой модуль мог изучить, что было до него. |
Дополнительные свойства не допускаются.
FRPStepOutput
Полезная нагрузка, которую гостевой модуль конвейера feature-recipe возвращает для одного шага конвейера: патчи RFC 6902, которые хост применяет к набору документов с ключами, побочные эффекты, созданные этим шагом, и любые диагностики, выданные гостевым модулем.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
patches | JSONPatchOp[] | нет | Структурированные операции RFC 6902, которые шаг выдаёт над документами набора с ключами. Каждая указывает целевой документ по области и ключу, а затем явно указывает операцию, путь и значение. В отличие от непрозрачного списка патчей роли label-transform: патчи шага FRP применяются хостом и восстанавливаются из снимка при неудачном шаге, поэтому операции здесь явные, а не непрозрачные. |
side_effects | SideEffect[] | нет | Эффекты, созданные этим шагом помимо изменения существующего документа (например, выдача CRD или запись файла). |
diagnostics | Diagnostic[] | нет | Диагностики, выданные гостевым модулем. Каждый элемент имеет общую форму диагностики Wasm-плагина. |
outputs | object | нет | Адресуемые выходные данные, которые гостевой модуль возвращает для этого шага, — упорядоченный автором набор ключей, заполняющий выходные данные шага для чтения последующим шагом или шаблоном. Сохраняет порядок автора, чтобы полезная нагрузка была побайтово идентичной между запусками с одинаковым вводом. Отсутствует, если шаг не возвращает выходных данных. |
error | string | нет | Сообщение о сбое, задаваемое, когда гостевой модуль выполнился, но не смог завершить операцию; отсутствует при успехе. Оно отличается от любых диагностик, которые несёт вывод: диагностики сообщают о проблемах, найденных во время выполнения, которое всё же дало результат, а error сообщает, что сама операция не завершилась. Присутствующую ошибку хост представляет как неудачный вызов плагина. |
Дополнительные свойства не допускаются.
DocumentSet
Набор адресуемых единиц с ключами и корнями по области, который гостевой модуль конвейера получает в качестве входной поверхности. Хост передаёт весь набор и не интерпретирует его содержимое; гостевой модуль выбирает целевые документы по содержимому и адресует свои патчи по ключу.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
own | map of Unit | да | Собственный отрендеренный вывод узла с ключами по токену единицы. Сохраняет порядок ключей, чтобы набор передавался в стабильном порядке, а полезная нагрузка была побайтово идентичной между запусками с одинаковым вводом. |
host | map of Unit | нет | Отрендеренный вывод компонента, к которому присоединена сущность FeatureRecipe с областью компонента, — межсущностная поверхность. Отсутствует для шагов Recipe и шагов FeatureRecipe с граничной областью, у которых нет компонента-хоста. Сохраняет порядок ключей, чтобы набор передавался в стабильном порядке, а полезная нагрузка была побайтово идентичной между запусками с одинаковым вводом. |
Дополнительные свойства не допускаются.
Unit
Одна адресуемая часть, на которые делится выдаваемый провайдером вывод, — гибридное представление одной части вывода. Структурированная единица несёт дерево (представление, адресуемое по RFC 6902) и является целью PATCH; непрозрачная единица несёт только свой тип медиа и байты (без дерева) и является целью SELECT и EMIT, но не целью PATCH.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
token | string | да | Непрозрачный позиционный адрес, назначаемый кодеком, — имя выдаваемого файла для однодокументного файла или <filename>#<ordinal> (порядок в файле), если один файл содержит несколько документов. Гостевой модуль считает его непрозрачным: он выбирает единицу по содержимому и возвращает токен, никогда не разбирая его. |
bytes | string | нет | Исходные байты единицы — источник для повторной сборки. Повторная сборка побайтово точна по построению: незатронутые байты соединяются заново из этого поля дословно. Каждый набор инструментов хранит их в собственном типе поля — в сыром виде, если это байтовый тип, и в кодировке base64, если это строка, которую шаг декодирует для их восстановления, — а сгенерированный кодировщик выполняет преобразование между полем и формой, в которой байты передаются. |
media_type | string | нет | Тип содержимого единицы (например, application/yaml для стандартного кодека YAML), чтобы гостевой модуль знал, с чем имеет дело. |
tree | любой | нет | Нормализованное представление единицы, адресуемое по RFC 6902, если кодек его создал; отсутствует, если не создал. Единица с деревом структурирована (цель PATCH); единица без дерева непрозрачна. Документ непрозрачен для хоста, который передаёт байты, не интерпретируя их, поэтому на этом уровне схемы дерево может содержать любое значение JSON. |
Дополнительные свойства не допускаются.
JSONPatchOp
Одна операция JSON-Patch по RFC 6902, которую шаг FRP выдаёт над одним документом набора с ключами. Scope и key указывают целевой документ; op, path, value и from задают операцию над позицией внутри этого документа.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
scope | string (enum) | да | Корень документов, на который направлена операция: own (собственные отрендеренные документы узла) или host (документы компонента, к которому присоединена сущность FeatureRecipe с областью компонента). Допустимые значения: "own", "host" |
key | string | да | Ключ имени выдаваемого файла в указанном корне — ключ, который гостевой модуль узнал во время выполнения из документа, выбранного по содержимому. |
op | string | да | Операция RFC 6902: одна из add, remove, replace, move, copy, test. |
path | string | да | JSON Pointer по RFC 6901, указывающий на целевую позицию в указанном документе. |
value | любой | нет | Операнд для add, replace и test; в остальных случаях опускается. Произвольный фрагмент документа JSON, созданный гостевым модулем, который хост передаёт непрозрачно; на этом уровне схемы он может содержать любое значение JSON. |
from | string | нет | Указатель источника для move и copy; в остальных случаях опускается. |
Дополнительные свойства не допускаются.
SideEffect
Один эффект, создаваемый шагом конвейера feature-recipe помимо изменения существующего документа. Kind равен emit_crd или emit_file; схема оставляет его открытой строкой, чтобы новый вид можно было добавить без нарушения ABI, а при любом другом виде сборка останавливается. Если kind равен emit_crd, crd содержит документ CRD, а file опускается; если kind равен emit_file, file содержит записываемый файл, а crd опускается.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | string | да | Вид эффекта: emit_crd или emit_file. Схема оставляет это поле открытой строкой, чтобы новый вид можно было добавить без нарушения ABI; при любом другом виде сборка останавливается с указанием узла, побочного эффекта и вида. |
scope | string (enum) | нет | Корень документов, в который вносит вклад выдача: own (собственный набор узла) или host (набор присоединённого компонента-хоста). Отсутствие scope означает own во время применения. Допустимые значения: "own", "host" |
crd | любой | нет | Документ CRD, который шаг выдаёт, когда kind равен emit_crd. Непрозрачен для хоста, который передаёт его, не интерпретируя; на этом уровне схемы может содержать любое значение JSON. |
file | SideEffectFile | нет | Файл, который записывает побочный эффект emit_file: целевой путь и содержимое файла. |
Дополнительные свойства не допускаются.
SideEffectFile
Файл, который записывает побочный эффект emit_file: целевой путь и содержимое файла.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
path | string | да | Целевой путь, по которому записывается файл. |
content | string | да | Записываемое содержимое файла. |
Дополнительные свойства не допускаются.
PrecedingStep
Один шаг конвейера, выполненный до текущего шага, чтобы гостевой модуль мог изучить то, что ему предшествовало: индекс шага в конвейере, плагин, который он указал, и побочные эффекты, порождённые этим шагом.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
index | integer | да | Позиция предыдущего шага в конвейере, отсчитываемая от нуля. |
plugin_uri | string | да | Плагин, который предыдущая запись конвейера указывает в своём поле plugin, в том виде, в каком он записан. |
side_effects | SideEffect[] | нет | Побочные эффекты, порождённые предыдущим шагом. |
Дополнительные свойства не допускаются.