Schema del socket Wasm dell’importatore di Aggrega
Riferimento generato. Non modificarlo a mano — rigeneralo a partire dal JSON Schema pubblicato.
Id dello schema: https://aggrega.ai/schemas/wasm-import-v1beta1.schema.json
Le forme di trasmissione che un socket di plugin importatore consuma (ImportInput) ed emette (ImportOutput). Un importatore trasforma una descrizione di infrastruttura esterna in entità Aggrega: legge i byte della sorgente per un formato nominato, mappa ciascun nodo della sorgente su un’entità del catalogo e restituisce le entità che ha emesso, le decisioni di mappatura che ha preso, le diagnostiche che ha sollevato e i file di scaffold che ha prodotto. Un importatore dichiara i formati che gestisce come capacità import:
Una delle forme seguenti
ImportInputImportOutput
Definizioni
ImportInput
Il payload che un guest importatore riceve: il formato sorgente che seleziona come leggere i byte, i byte della sorgente primaria e il nome del file da cui sono stati letti, le eventuali sorgenti nominate per un’importazione multi-file, un documento di opzioni opaco facoltativo che il consumatore fornisce per un comportamento specifico dell’importatore, una vista dei Components che il catalogo del workspace contiene, e il target per cui l’importazione redige le bozze.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
format | string | sì | Il nome del formato sorgente da importare, corrispondente a una delle capacità import: |
bytes | string | sì | I byte della sorgente primaria da importare, che l’importatore legge nel formato nominato: l’intero file dove la sorgente dell’importazione è un file, e vuoto dove è una directory, i cui file arrivano invece come sorgenti nominate. Ogni kit li porta nel proprio tipo di campo — grezzi dove quel tipo è un tipo di byte, codificati in base64 dove è una stringa che l’importatore decodifica per recuperarli — e l’encoder generato converte tra il campo e la forma in cui il formato di trasmissione porta i byte. |
name | string | no | Il nome della sorgente dell’importazione, senza alcuna directory davanti, così che un importatore possa nominare la sorgente in ciò che riporta e in ciò che genera in bozza. Dove la sorgente è un solo file, è il nome di base del file: i byte primari non arrivano come sorgente nominata, quindi questo è l’unico nome che portano. Dove la sorgente è una directory, è il nome di base della directory, e i file della directory arrivano comunque come sorgenti nominate, ciascuno con il proprio nome, con i byte primari vuoti. Assente dove la sorgente non ha alcun nome da dare. |
sources | ImportSource[] | no | Sorgenti nominate, ciascuna con i propri byte, in un’unica lista ordinata per nome. Dove la sorgente dell’importazione è una directory, ce n’è una per ciascun suo file che i modelli di file dichiarati dall’importatore selezionano, nominata con il suo percorso separato da barre all’interno della directory. Anche i file che l’associazione che configura l’importatore dichiara sotto with.sources sono portati qui, ciascuno con il proprio nome di base, e l’host rifiuta un’importazione in cui un file letto dalla directory e uno di questi portano lo stesso nome. Assente dove nessuno dei due ne fornisce. |
settings | any | no | Un documento opaco di opzioni di importazione che il consumatore fornisce per un comportamento specifico dell’importatore. L’host lo passa senza interpretarlo; l’importatore legge qualunque forma esso documenti. Assente quando il consumatore non fornisce opzioni. |
catalog | CatalogProjection | no | Una vista dei Components che il catalogo proprio del workspace contiene — il catalogo da cui è stato selezionato l’importatore stesso — così che l’importatore possa valutarli come candidati quando mappa un nodo della sorgente su un’entità del catalogo. L’host la costruisce solo da quel catalogo locale, e porta solo nomi, versioni, etichette e struttura dichiarata: mai un valore, un valore predefinito o un segreto. Il suo ordine è fisso, quindi un catalogo produce un’unica sequenza di byte. Assente quando il catalogo non contiene alcun Component. |
target | string | no | La capacità del provider per cui l’importazione redige le bozze, come compose o helm: il target fornito all’importazione oppure, per un’importazione che ne aggiorna una precedente e non ne indica alcuno, il target registrato da quell’importazione precedente. Un importatore scrive nelle bozze, come dichiarazioni, ciò che serve solo a quel target, e tralascia ciò che serve solo a un altro target. L’host lo inoltra così come viene fornito, dopo aver verificato che una Recipe del catalogo del workspace vi si leghi. Assente quando l’importazione non indica alcun target. |
Non sono consentite proprietà aggiuntive.
CatalogProjection
Il catalogo del workspace come lo vede un importatore: una voce per ciascun Component che il catalogo contiene, ciascuna con i metadati che un importatore valuta quando assegna un punteggio a un candidato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
components | CatalogComponent[] | sì | Una voce per ciascun nome di Component che il catalogo contiene, ordinata per nome. Dove il catalogo contiene più versioni di un Component, la sua voce descrive la versione a cui si risolve un riferimento che nomina il Component senza versione. |
Non sono consentite proprietà aggiuntive.
CatalogComponent
Un Component del catalogo del workspace: il suo nome e la sua versione, le sue etichette, i nomi delle chiavi che dichiarano i suoi values e provides, e i socket che dichiara per le sue dipendenze. Un Component che ne estende un altro porta ciò che eredita oltre a ciò che dichiara esso stesso.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
name | string | sì | Il nome del Component, come lo dichiara il suo metadata.name — il nome con cui un Aggregate vi fa riferimento. |
version | string | sì | La versione del Component, come la dichiara il suo metadata.version. |
labels | mappa di string | no | Le etichette del Component, come mappa da stringa a stringa. Assente quando non ne porta alcuna. |
values | string[] | no | I nomi delle chiavi di primo livello che dichiarano i values del Component, ordinati. Solo un elenco di nomi: non porta mai un valore o un valore predefinito. Assente quando i suoi values non dichiarano alcuna chiave. |
provides | string[] | no | I nomi delle chiavi di primo livello che dichiarano i provides del Component, ordinati. Solo un elenco di nomi: non porta mai un valore. Assente quando i suoi provides non dichiarano alcuna chiave. |
sockets | CatalogSocket[] | no | I socket che il Component dichiara per le sue dipendenze, in ordine di dichiarazione: per un Component che ne estende un altro, vengono prima i socket che eredita, nell’ordine in cui li dichiara il Component esteso, seguiti da quelli che aggiunge. Assente quando non ne dichiara alcuno. |
Non sono consentite proprietà aggiuntive.
CatalogSocket
Un socket che un Component del catalogo dichiara per le sue dipendenze: il nome del socket e il selettore di etichette che una dipendenza collegata attraverso di esso deve soddisfare.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
name | string | sì | Il nome del socket, come lo dichiara lo usesSchema del Component. |
selector | string | sì | Il selettore di etichette del socket, testualmente, nella grammatica in stile Kubernetes in cui lo scrive il Component: le etichette che una dipendenza collegata attraverso questo socket deve portare. |
Non sono consentite proprietà aggiuntive.
ImportSource
Una sorgente nominata all’interno di un’importazione multi-file o di directory: un nome che individua la sorgente e i suoi byte.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
name | string | sì | Il nome di questa sorgente all’interno dell’importazione, come un percorso di file relativo. |
bytes | string | sì | I byte di questa sorgente. Ogni kit li porta nel proprio tipo di campo — grezzi dove quel tipo è un tipo di byte, codificati in base64 dove è una stringa che l’importatore decodifica per recuperarli — e l’encoder generato converte tra il campo e la forma in cui il formato di trasmissione porta i byte. |
Non sono consentite proprietà aggiuntive.
ImportOutput
Il payload che un guest importatore restituisce: le entità che l’importazione ha prodotto, le decisioni di mappatura che stanno dietro di esse, le diagnostiche che l’importazione ha sollevato e i file di scaffold che ha prodotto. Ogni campo è facoltativo, così un’importazione che non ha risolto nulla può restituire solo diagnostiche.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
entities | EmittedEntity[] | no | Le entità che l’importazione ha prodotto, ciascuna un riferimento a un’entità esistente del catalogo oppure il corpo di un’entità redatta. Assente quando l’importazione non ha emesso entità. |
decisions | ImportDecision[] | no | Le decisioni di mappatura che l’importazione ha preso, una per ciascun nodo della sorgente che ha risolto, che registrano i candidati che ha valutato e la scelta che ha fatto. Assente quando l’importazione non ha registrato decisioni. |
diagnostics | Diagnostic[] | no | Le diagnostiche che l’importazione ha sollevato — per esempio un nodo della sorgente non risolto o una mappatura ambigua. Assente quando l’importazione non ne ha prodotte. |
files | ScaffoldFile[] | no | I file di scaffold che l’importazione ha prodotto accanto alle entità, come un aggregato di partenza o un readme. Assente quando l’importazione non ha prodotto file. |
error | string | no | Un 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.
EmittedEntity
Un’entità che l’importazione ha prodotto: il suo tipo, il suo nome e il modo in cui viene emessa — un riferimento a un’entità esistente del catalogo o il corpo di un’entità appena redatta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | string | sì | Il tipo di entità emessa. Gli importatori del core emettono Component, Aggregate e Release; un lettore tollera qualsiasi altro tipo. |
name | string | sì | Il nome dell’entità emessa. |
mode | string (enum) | sì | Come viene emessa l’entità: reference punta per nome a un’entità esistente del catalogo, e draft porta il corpo di un’entità appena redatta. Valori consentiti: "reference", "draft" |
body | string | no | Il corpo YAML grezzo di un’entità redatta. Vuoto per un riferimento puro, che nomina un’entità esistente anziché redigerne una. |
labels | mappa di string | no | Etichette da associare all’entità emessa, come mappa da stringa a stringa. Gli importatori del core la lasciano vuota. |
annotations | mappa di string | no | Annotazioni da associare all’entità emessa, come mappa da stringa a stringa. Gli importatori del core la lasciano vuota. |
sourceRef | string | no | Un riferimento al nodo della sorgente da cui è stata emessa questa entità, così che un lettore possa ricondurre l’entità alla sua origine nella sorgente importata. |
decisionRef | string | no | Un riferimento alla decisione di mappatura che ha prodotto questa entità, che la collega ai candidati valutati e alla scelta fatta. |
Non sono consentite proprietà aggiuntive.
ImportDecision
Una decisione di mappatura: il nodo della sorgente che l’importatore ha risolto, le entità candidate del catalogo che ha valutato, il candidato che ha scelto e il ragionamento dietro la scelta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
sourceNode | DecisionSourceNode | sì | Il nodo della sorgente che questa decisione ha risolto: il nodo che l’importatore ha letto dalla sorgente e mappato su un’entità del catalogo. |
candidates | ImportCandidate[] | no | Le entità candidate del catalogo che l’importatore ha valutato per questo nodo della sorgente, ciascuna con il suo punteggio e la scomposizione per segnale dietro quel punteggio. Assente quando l’importatore non ha valutato candidati. |
chosen | DecisionChoice | no | Il candidato che l’importatore ha scelto per questo nodo della sorgente, e come lo ha emesso. Assente quando l’importatore non ha fatto alcuna scelta. |
rationale | string | no | Una spiegazione leggibile dalle persone del perché l’importatore ha fatto questa scelta. |
swapHint | string | no | Un suggerimento che descrive come sostituire la mappatura scelta con un’alternativa, così che un lettore possa rivedere la decisione. |
Non sono consentite proprietà aggiuntive.
DecisionSourceNode
Il nodo della sorgente che una decisione di mappatura ha risolto: un identificatore, il tipo con cui la sorgente lo nomina e un riepilogo leggibile dalle persone dei suoi parametri.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
id | string | sì | L’identificatore del nodo della sorgente all’interno della sorgente importata. |
type | string | sì | Il tipo del nodo della sorgente come lo nomina la sorgente. |
paramsSummary | string | sì | Un riepilogo leggibile dalle persone dei parametri del nodo della sorgente, da mostrare accanto alla decisione. |
Non sono consentite proprietà aggiuntive.
ImportCandidate
Un’entità candidata del catalogo che l’importatore ha valutato per un nodo della sorgente: il componente candidato, il suo punteggio complessivo, il livello di corrispondenza in cui ricade il punteggio e la scomposizione per segnale dietro il punteggio.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
componentName | string | sì | Il nome del componente candidato del catalogo. |
score | number | sì | Il punteggio di corrispondenza complessivo del candidato, aggregato dalla scomposizione per segnale. |
tier | string | sì | Il livello di corrispondenza in cui ricade il candidato, una fascia approssimativa sul punteggio. |
signals | CandidateSignals | sì | La scomposizione per segnale dietro il punteggio del candidato. |
Non sono consentite proprietà aggiuntive.
CandidateSignals
La scomposizione per segnale dietro il punteggio di un candidato: un contributo per ciascun segnale corrispondente. Un oggetto a campi fissi, così l’insieme dei segnali è stabile e il formato di trasmissione è deterministico.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
table | number | sì | Il contributo al punteggio del segnale della tabella di mappatura. |
category | number | sì | Il contributo al punteggio del segnale della categoria. |
domainLabels | number | sì | Il contributo al punteggio del segnale delle etichette di dominio. |
shape | number | sì | Il contributo al punteggio del segnale della forma. |
name | number | sì | Il contributo al punteggio del segnale del nome. |
Non sono consentite proprietà aggiuntive.
DecisionChoice
Il candidato che una decisione di mappatura ha scelto: l’entità di destinazione del catalogo, come viene emessa e il livello di corrispondenza della scelta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
target | string | sì | Il nome dell’entità di destinazione scelta del catalogo. |
mode | string | sì | Come viene emessa la destinazione scelta, rispecchiando la modalità di un’entità emessa: un riferimento a un’entità esistente o un corpo appena redatto. |
tier | string | sì | Il livello di corrispondenza della destinazione scelta. |
Non sono consentite proprietà aggiuntive.
ScaffoldFile
Un file di scaffold che l’importazione ha prodotto: un percorso relativo alla radice dell’output dell’importazione e il contenuto del file.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
path | string | sì | Il percorso del file di scaffold, relativo alla radice dell’output dell’importazione. |
content | string | sì | Il contenuto del file di scaffold. |
Non sono consentite proprietà aggiuntive.