Salta ai contenuti
AggregaAggrega
Seleziona lingua: Italiano
Questa pagina è stata tradotta automaticamente. Leggi l’originale in inglese.

Schema del socket Wasm del passo di pipeline di FeatureRecipe di Aggrega

Riferimento generato. Non modificarlo a mano — rigeneralo a partire dal JSON Schema pubblicato.

Id dello schema: https://aggrega.ai/schemas/wasm-frp-step-v1beta1.schema.json

Le forme di trasmissione che un socket di plugin per passi di pipeline feature-recipe consuma (FRPStepInput) ed emette (FRPStepOutput). Un passo FRP viene eseguito per ogni voce di pipeline inline dichiarata in una Recipe o in una FeatureRecipe: l’host passa al passo l’insieme di documenti indicizzato per intero, il passo seleziona in base al contenuto i documenti a cui mira, e restituisce patch RFC 6902 indirizzate per chiave insieme a effetti collaterali e diagnostiche. Questo è un contratto del guest distinto dal ruolo label-transform, che viene eseguito una sola volta sull’intero grafo della topologia e restituisce patch di etichette opache. I tipi di payload Go, Rust e TypeScript sono generati da questo schema nei pacchetti dell’ABI dei plugin, così i tre linguaggi leggono e scrivono lo stesso formato di trasmissione; un guest li importa da quei pacchetti, oppure tramite il suo kit per plugin dove il kit li riesporta.

Una delle forme seguenti

  • FRPStepInput
  • FRPStepOutput

Definizioni

FRPStepInput

Il payload che un guest della pipeline feature-recipe riceve per un passo di pipeline: l’insieme di documenti indicizzato che l’host passa per intero, l’input locale al passo che la Recipe ha dichiarato per questo passo, il contesto al momento del rendering, la posizione del passo nella pipeline e una registrazione dei passi già eseguiti.

ProprietàTipoObbligatoriaDescrizione
documentsDocumentSetsìL’insieme indicizzato, radicato in un ambito, di unità indirizzabili che un guest della pipeline riceve come propria superficie di input. L’host passa l’intero insieme e non ne interpreta il contenuto; il guest seleziona in base al contenuto i documenti a cui mira e indirizza le proprie patch per chiave.
step_inputobjectnoIl blocco with renderizzato del passo, un insieme di chiavi nell’ordine dell’autore che il guest legge come proprio input locale al passo. Preserva l’ordine dell’autore così il payload è identico byte per byte tra esecuzioni con input identico.
contextobjectsìIl contesto al momento del rendering che l’host passa al passo, portato come i byte del suo documento JSON; questo schema lascia l’oggetto non dichiarato, e l’host non ne rilegge nulla. Un passo di una Recipe o di una FeatureRecipe con ambito di componente riceve parameters, i valori dei parametri della Release ordinati per nome e assenti quando non ce ne sono; annotations, le annotazioni del nodo suddivise in base a dove ciascuna è stata scritta in aggregate, release e catalog, ciascuno assente quando è vuoto; e boundary, il confine in cui si trova il nodo: name, path (i suoi segmenti), sync_wave (assente quando è 0), directory, sub_directory (assente quando non ce n’è uno) e annotations (l’insieme che i confini della Release propagano a cascata fino al nodo, con la voce propria del nodo nella Release applicata per ultima; assente quando è vuoto). Un passo di una FeatureRecipe con ambito di confine, che non ha alcun componente host, riceve parameters; annotations che porta solo il contenitore release, che è l’insieme di annotazioni proprio del confine; e un boundary che porta il suo name, il suo path e quello stesso insieme come annotations. Il rendering del provider della stessa FeatureRecipe riceve lo stesso contesto. La larghezza dell’indentazione, yaml_indent, non è impostata per un passo.
step_indexintegersìLa posizione di questo passo nella pipeline, a partire da zero.
preceding_stepsPrecedingStep[]noI passi della pipeline eseguiti prima di questo passo, così un guest può esaminare ciò che lo ha preceduto.

Non sono consentite proprietà aggiuntive.

FRPStepOutput

Il payload che un guest della pipeline feature-recipe restituisce per un passo di pipeline: le patch RFC 6902 che l’host applica all’insieme di documenti indicizzato, gli effetti collaterali prodotti da questo passo e le eventuali diagnostiche sollevate dal guest.

ProprietàTipoObbligatoriaDescrizione
patchesJSONPatchOp[]noOperazioni RFC 6902 strutturate che il passo emette sui documenti dell’insieme indicizzato. Ciascuna nomina il proprio documento di destinazione per scope e key, poi nomina in modo esplicito op, path e value. Distinte dall’elenco di patch opaco del ruolo label-transform: le patch di un passo FRP vengono applicate dall’host e ripristinate tramite snapshot in caso di passo non riuscito, quindi qui le operazioni sono esplicite anziché opache.
side_effectsSideEffect[]noGli effetti che questo passo ha prodotto oltre a modificare tramite patch un documento esistente (per esempio l’emissione di una CRD o la scrittura di un file).
diagnosticsDiagnostic[]noDiagnostiche sollevate dal guest. Ogni elemento è la forma di diagnostica condivisa dei plugin Wasm.
outputsobjectnoGli output indirizzabili che il guest restituisce per questo passo, un insieme di chiavi nell’ordine dell’autore che popola gli output del passo affinché un passo successivo o un template li legga. Preserva l’ordine dell’autore così il payload è identico byte per byte tra esecuzioni con input identico. Assente quando il passo non restituisce alcun output.
errorstringnoUn messaggio di errore impostato quando il guest è stato eseguito ma non ha potuto completare l’operazione; assente in caso di successo. È distinto da qualsiasi diagnostica portata dall’output: le diagnostiche riportano problemi trovati durante un’esecuzione che ha comunque prodotto un risultato, mentre error riporta che l’operazione stessa non è stata completata. L’host presenta un errore presente come un’invocazione del plugin non riuscita.

Non sono consentite proprietà aggiuntive.

DocumentSet

L’insieme indicizzato, radicato in un ambito, di unità indirizzabili che un guest della pipeline riceve come propria superficie di input. L’host passa l’intero insieme e non ne interpreta il contenuto; il guest seleziona in base al contenuto i documenti a cui mira e indirizza le proprie patch per chiave.

ProprietàTipoObbligatoriaDescrizione
ownmappa di UnitsìL’output renderizzato proprio del nodo, indicizzato per token di unità. Preserva l’ordine delle chiavi così l’insieme raggiunge il formato di trasmissione in un ordine stabile e il payload è identico byte per byte tra esecuzioni con input identico.
hostmappa di UnitnoL’output renderizzato del componente a cui è associata una FeatureRecipe con ambito di componente — la superficie tra entità. Assente per i passi di Recipe e per i passi di FeatureRecipe con ambito di confine, che non hanno alcun componente host. Preserva l’ordine delle chiavi così l’insieme raggiunge il formato di trasmissione in un ordine stabile e il payload è identico byte per byte tra esecuzioni con input identico.

Non sono consentite proprietà aggiuntive.

Unit

Un pezzo indirizzabile in cui si suddivide l’output emesso da un provider — la vista ibrida di un pezzo di output. Un’unità strutturata porta un albero (una vista indirizzabile tramite RFC 6902) ed è una destinazione PATCH; un’unità opaca porta solo il proprio media type e i propri byte (nessun albero) ed è una destinazione SELECT ed EMIT ma non una destinazione PATCH.

ProprietàTipoObbligatoriaDescrizione
tokenstringsìL’indirizzo posizionale opaco che il codec assegna — il nome del file emesso per un file con un solo documento, oppure <filename>#<ordinal> (ordine nel file) quando un file porta più documenti. Il guest lo tratta come opaco: seleziona un’unità in base al contenuto e ne riecheggia il token, senza mai analizzarlo.
bytesstringnoI byte originali dell’unità, la sorgente del riassemblaggio. Il riassemblaggio è fedele al byte per costruzione: i byte non toccati vengono ricongiunti alla lettera a partire da questi. Ogni kit li porta nel proprio tipo di campo — grezzi dove quel tipo è un tipo di byte, codificati in base64 dove è una stringa che il passo decodifica per recuperarli — e l’encoder generato converte tra il campo e la forma in cui il formato di trasmissione porta i byte.
media_typestringnoIl tipo di contenuto dell’unità (per esempio application/yaml per il codec YAML di serie), così il guest sa che cosa sta guardando.
treeanynoLa vista normalizzata dell’unità indirizzabile tramite RFC 6902 quando il codec ne ha prodotta una, oppure assente quando non l’ha prodotta. Un’unità con un albero è strutturata (una destinazione PATCH); un’unità senza albero è opaca. Il documento è opaco per l’host, che ne fa passare i byte senza interpretarli, quindi l’albero porta qualsiasi valore JSON a questo livello dello schema.

Non sono consentite proprietà aggiuntive.

JSONPatchOp

Un’operazione JSON-Patch RFC 6902 che un passo FRP emette su un documento dell’insieme indicizzato. Scope e key nominano il documento di destinazione; op, path, value e from portano l’operazione verso una posizione all’interno di quel documento.

ProprietàTipoObbligatoriaDescrizione
scopestring (enum)sìLa radice dei documenti a cui mira l’operazione: own (i documenti renderizzati propri del nodo) oppure host (i documenti del componente a cui è associata una FeatureRecipe con ambito di componente). Valori consentiti: "own", "host"
keystringsìLa chiave del nome di file emesso all’interno della radice nominata — la chiave che il guest ha appreso in fase di esecuzione dal documento che ha selezionato in base al contenuto.
opstringsìL’operazione RFC 6902: una tra add, remove, replace, move, copy, test.
pathstringsìUn JSON Pointer RFC 6901 verso la posizione di destinazione all’interno del documento nominato.
valueanynoL’operando per add, replace e test, omesso altrimenti. Un frammento arbitrario di documento JSON scritto dal guest, che l’host fa passare in modo opaco; porta qualsiasi valore JSON a questo livello dello schema.
fromstringnoIl puntatore di origine per move e copy, omesso altrimenti.

Non sono consentite proprietà aggiuntive.

SideEffect

Un effetto che un passo della pipeline feature-recipe produce oltre alla modifica tramite patch di un documento esistente. Kind è emit_crd o emit_file; lo schema lo lascia una stringa aperta così che un nuovo tipo possa essere aggiunto senza una rottura dell’ABI, e una build si arresta su qualsiasi altro tipo. Quando kind è emit_crd, crd porta il documento CRD e file è omesso; quando kind è emit_file, file porta il file da scrivere e crd è omesso.

ProprietàTipoObbligatoriaDescrizione
kindstringsìIl tipo di effetto: emit_crd o emit_file. Lo schema lascia il campo una stringa aperta così che un nuovo tipo possa essere aggiunto senza una rottura dell’ABI; una build si arresta su qualsiasi altro tipo, nominando il nodo, l’effetto collaterale e il tipo.
scopestring (enum)noLa radice dei documenti a cui contribuisce l’emissione: own (l’insieme proprio del nodo) o host (l’insieme del componente host associato). Uno scope assente significa own al momento dell’applicazione. Valori consentiti: "own", "host"
crdanynoIl documento CRD che il passo emette quando kind è emit_crd. Opaco per l’host, che lo passa senza interpretarlo; porta qualsiasi valore JSON a questo livello dello schema.
fileSideEffectFilenoIl file che un effetto collaterale emit_file scrive: il percorso di destinazione e il contenuto del file.

Non sono consentite proprietà aggiuntive.

SideEffectFile

Il file che un effetto collaterale emit_file scrive: il percorso di destinazione e il contenuto del file.

ProprietàTipoObbligatoriaDescrizione
pathstringsìIl percorso di destinazione in cui viene scritto il file.
contentstringsìIl contenuto del file da scrivere.

Non sono consentite proprietà aggiuntive.

PrecedingStep

Un passo della pipeline eseguito prima del passo corrente, così che un guest possa esaminare ciò che lo ha preceduto: l’indice del passo nella pipeline, il plugin che ha nominato e gli effetti collaterali che quel passo ha emesso.

ProprietàTipoObbligatoriaDescrizione
indexintegersìLa posizione, a partire da zero, del passo precedente nella pipeline.
plugin_uristringsìIl plugin che la voce precedente della pipeline nomina nel suo campo plugin, così come è scritto.
side_effectsSideEffect[]noGli effetti collaterali che il passo precedente ha emesso.

Non sono consentite proprietà aggiuntive.