Ir al contenido
AggregaAggrega
Seleccionar idioma: Español
Esta página se tradujo automáticamente. Lee el original en inglés.

Esquema del socket Wasm de paso de pipeline de FeatureRecipe de Aggrega

Referencia generada. No la edites a mano — regenérala a partir del JSON Schema publicado.

ID del esquema: https://aggrega.ai/schemas/wasm-frp-step-v1beta1.schema.json

Las formas de transmisión que un socket de plugin de paso de pipeline feature-recipe consume (FRPStepInput) y emite (FRPStepOutput). Un paso FRP se ejecuta por cada entrada de pipeline en línea declarada en una Recipe o una FeatureRecipe: el host entrega al paso el conjunto de documentos indexado por clave completo, el paso selecciona por contenido los documentos a los que apunta y devuelve parches RFC 6902 dirigidos por clave junto con efectos secundarios y diagnósticos. Este es un contrato de guest distinto del rol label-transform, que se ejecuta una sola vez sobre todo el grafo de topología y devuelve parches de etiquetas opacos. Los tipos de payload de Go, Rust y TypeScript se generan a partir de este esquema en los paquetes de la ABI de plugins, de modo que los tres lenguajes leen y escriben el mismo formato de transmisión; un guest los importa desde esos paquetes, o a través de su kit de plugins cuando el kit los reexporta.

Una de las siguientes formas

  • FRPStepInput
  • FRPStepOutput

Definiciones

FRPStepInput

El payload que un guest de pipeline feature-recipe recibe para un paso de pipeline: el conjunto de documentos indexado por clave que el host entrega completo, la entrada local al paso que la Recipe declaró para este paso, el contexto del momento del renderizado, la posición del paso en el pipeline y un registro de los pasos que ya se ejecutaron.

PropiedadTipoObligatoriaDescripción
documentsDocumentSetsíEl conjunto indexado por clave, con raíz en un ámbito, de unidades direccionables que un guest de pipeline recibe como su superficie de entrada. El host entrega el conjunto completo y no interpreta su contenido; el guest selecciona por contenido los documentos a los que apunta y dirige sus parches por clave.
step_inputobjectnoEl bloque with renderizado del paso, un conjunto de claves en el orden del autor que el guest lee como su entrada local al paso. Conserva el orden del autor para que el payload sea idéntico byte a byte entre ejecuciones con entrada idéntica.
contextobjectsíEl contexto del momento del renderizado que el host entrega al paso, transportado como los bytes de su documento JSON; este esquema deja el objeto sin declarar, y el host no lee nada de vuelta de él. Un paso de una Recipe o de una FeatureRecipe con ámbito de componente recibe parameters, los valores de parámetros de la Release ordenados por nombre y ausentes cuando no hay ninguno; annotations, las anotaciones del nodo divididas según dónde se escribió cada una en aggregate, release y catalog, cada uno ausente cuando está vacío; y boundary, el límite en el que se encuentra el nodo: name, path (sus segmentos), sync_wave (ausente cuando es 0), directory, sub_directory (ausente cuando no hay ninguno) y annotations (el conjunto que los límites de la Release propagan en cascada hasta el nodo, con su propia entrada de la Release aplicada en último lugar; ausente cuando está vacío). Un paso de una FeatureRecipe con ámbito de límite, que no tiene componente host, recibe parameters; annotations, que lleva solo el contenedor release, que es el conjunto de anotaciones propio del límite; y un boundary que lleva su name, su path y ese mismo conjunto como sus annotations. El renderizado del proveedor de la misma FeatureRecipe recibe el mismo contexto. El ancho de la sangría, yaml_indent, no se establece para un paso.
step_indexintegersíLa posición de este paso en el pipeline, contada desde cero.
preceding_stepsPrecedingStep[]noLos pasos del pipeline que se ejecutaron antes de este paso, para que un guest pueda inspeccionar lo que lo precedió.

No se permiten propiedades adicionales.

FRPStepOutput

El payload que un guest de pipeline feature-recipe devuelve para un paso de pipeline: los parches RFC 6902 que el host aplica al conjunto de documentos indexado por clave, los efectos secundarios que produjo este paso y los diagnósticos que haya planteado el guest.

PropiedadTipoObligatoriaDescripción
patchesJSONPatchOp[]noOperaciones RFC 6902 estructuradas que el paso emite contra documentos del conjunto indexado por clave. Cada una nombra su documento de destino por scope y key, y luego nombra explícitamente op, path y value. Distintas de la lista de parches opaca del rol label-transform: los parches de un paso FRP los aplica el host y se restauran mediante snapshot en un paso fallido, por lo que aquí las operaciones son explícitas en lugar de opacas.
side_effectsSideEffect[]noLos efectos que este paso produjo más allá de parchear un documento existente (por ejemplo, emitir un CRD o escribir un archivo).
diagnosticsDiagnostic[]noDiagnósticos que planteó el guest. Cada elemento es la forma de diagnóstico compartida de los plugins Wasm.
outputsobjectnoLas salidas direccionables que el guest devuelve para este paso, un conjunto de claves en el orden del autor que rellena las salidas del paso para que un paso posterior o una plantilla las lea. Conserva el orden del autor para que el payload sea idéntico byte a byte entre ejecuciones con entrada idéntica. Ausente cuando el paso no devuelve ninguna salida.
errorstringnoUn mensaje de error que se establece cuando el guest se ejecutó pero no pudo completar la operación; ausente en caso de éxito. Es distinto de cualquier diagnóstico que lleve la salida: los diagnósticos informan de problemas encontrados durante una ejecución que aun así produjo un resultado, mientras que error informa de que la propia operación no se completó. El host presenta un error presente como una invocación de plugin fallida.

No se permiten propiedades adicionales.

DocumentSet

El conjunto indexado por clave, con raíz en un ámbito, de unidades direccionables que un guest de pipeline recibe como su superficie de entrada. El host entrega el conjunto completo y no interpreta su contenido; el guest selecciona por contenido los documentos a los que apunta y dirige sus parches por clave.

PropiedadTipoObligatoriaDescripción
ownmapa de UnitsíLa salida renderizada propia del nodo, indexada por token de unidad. Conserva el orden de las claves para que el conjunto llegue al formato de transmisión en un orden estable y el payload sea idéntico byte a byte entre ejecuciones con entrada idéntica.
hostmapa de UnitnoLa salida renderizada del componente al que está vinculada una FeatureRecipe con ámbito de componente — la superficie entre entidades. Ausente para los pasos de Recipe y los pasos de FeatureRecipe con ámbito de límite, que no tienen componente host. Conserva el orden de las claves para que el conjunto llegue al formato de transmisión en un orden estable y el payload sea idéntico byte a byte entre ejecuciones con entrada idéntica.

No se permiten propiedades adicionales.

Unit

Una pieza direccionable en la que se divide la salida emitida de un proveedor — la vista híbrida de una pieza de salida. Una unidad estructurada lleva un árbol (una vista direccionable según RFC 6902) y es un destino PATCH; una unidad opaca lleva solo su tipo de medio y sus bytes (ningún árbol) y es un destino SELECT y EMIT pero no un destino PATCH.

PropiedadTipoObligatoriaDescripción
tokenstringsíLa dirección posicional opaca que asigna el codec — el nombre de archivo emitido para un archivo de un solo documento, o <filename>#<ordinal> (orden en el archivo) cuando un archivo lleva varios documentos. El guest la trata como opaca: selecciona una unidad por contenido y devuelve el token tal cual, sin analizarlo nunca.
bytesstringnoLos bytes originales de la unidad, el origen del reensamblado. El reensamblado es fiel al byte por construcción: los bytes no tocados se vuelven a unir literalmente a partir de estos. Cada kit los lleva en su propio tipo de campo — en bruto donde ese tipo es un tipo de bytes, codificados en base64 donde es una cadena que el paso decodifica para recuperarlos — y el codificador generado convierte entre el campo y la forma en que el formato de transmisión lleva los bytes.
media_typestringnoEl tipo de contenido de la unidad (por ejemplo, application/yaml para el codec YAML estándar), para que el guest sepa qué está mirando.
treeanynoLa vista normalizada de la unidad direccionable según RFC 6902 cuando el codec produjo una, o ausente cuando no. Una unidad con árbol es estructurada (un destino PATCH); una unidad sin árbol es opaca. El documento es opaco para el host, que hace pasar los bytes sin interpretarlos, de modo que el árbol lleva cualquier valor JSON en esta capa del esquema.

No se permiten propiedades adicionales.

JSONPatchOp

Una operación JSON-Patch RFC 6902 que un paso FRP emite contra un documento del conjunto indexado por clave. Scope y key nombran el documento de destino; op, path, value y from llevan la operación contra una ubicación dentro de ese documento.

PropiedadTipoObligatoriaDescripción
scopestring (enum)síLa raíz de documentos a la que apunta la operación: own (los documentos renderizados propios del nodo) o host (los documentos del componente al que está vinculada una FeatureRecipe con ámbito de componente). Valores permitidos: "own", "host"
keystringsíLa clave del nombre de archivo emitido dentro de la raíz nombrada — la clave que el guest conoció en tiempo de ejecución a partir del documento que seleccionó por contenido.
opstringsíLa operación RFC 6902: una de add, remove, replace, move, copy, test.
pathstringsíUn JSON Pointer RFC 6901 hacia la ubicación de destino dentro del documento nombrado.
valueanynoEl operando para add, replace y test, omitido en otro caso. Un fragmento arbitrario de documento JSON escrito por el guest, que el host hace pasar de forma opaca; lleva cualquier valor JSON en esta capa del esquema.
fromstringnoEl puntero de origen para move y copy, omitido en otro caso.

No se permiten propiedades adicionales.

SideEffect

Un efecto que un paso de pipeline feature-recipe produce más allá de parchear un documento existente. Kind es emit_crd o emit_file; el esquema lo deja como una cadena abierta para que se pueda añadir un nuevo tipo sin una ruptura de la ABI, y una compilación se detiene ante cualquier otro tipo. Cuando kind es emit_crd, crd lleva el documento CRD y file se omite; cuando kind es emit_file, file lleva el archivo que se debe escribir y crd se omite.

PropiedadTipoObligatoriaDescripción
kindstringsíEl tipo de efecto: emit_crd o emit_file. El esquema deja el campo como una cadena abierta para que se pueda añadir un nuevo tipo sin una ruptura de la ABI; una compilación se detiene ante cualquier otro tipo, nombrando el nodo, el efecto secundario y el tipo.
scopestring (enum)noLa raíz de documentos a la que contribuye la emisión: own (el conjunto propio del nodo) o host (el conjunto del componente host vinculado). Un scope ausente significa own en el momento de la aplicación. Valores permitidos: "own", "host"
crdanynoEl documento CRD que emite el paso cuando kind es emit_crd. Opaco para el host, que lo transmite sin interpretarlo; lleva cualquier valor JSON en esta capa del esquema.
fileSideEffectFilenoEl archivo que escribe un efecto secundario emit_file: la ruta de destino y el contenido del archivo.

No se permiten propiedades adicionales.

SideEffectFile

El archivo que escribe un efecto secundario emit_file: la ruta de destino y el contenido del archivo.

PropiedadTipoObligatoriaDescripción
pathstringsíLa ruta de destino en la que se escribe el archivo.
contentstringsíEl contenido del archivo que se debe escribir.

No se permiten propiedades adicionales.

PrecedingStep

Un paso de pipeline que se ejecutó antes del paso actual, para que un guest pueda inspeccionar lo que vino antes: el índice del paso en el pipeline, el plugin que nombró y los efectos secundarios que emitió ese paso.

PropiedadTipoObligatoriaDescripción
indexintegersíLa posición, empezando por cero, del paso anterior en el pipeline.
plugin_uristringsíEl plugin que la entrada anterior del pipeline nombra en su campo plugin, tal como está escrito.
side_effectsSideEffect[]noLos efectos secundarios que emitió el paso anterior.

No se permiten propiedades adicionales.