Zum Inhalt springen
AggregaAggrega
Sprache wählen: Deutsch
Diese Seite wurde maschinell übersetzt. Das englische Original lesen.

Aggrega-Schema für den Wasm-Importer-Socket

Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.

Schema-ID: https://aggrega.ai/schemas/wasm-import-v1beta1.schema.json

Die Übertragungsformen, die ein Importer-Plugin-Socket konsumiert (ImportInput) und ausgibt (ImportOutput). Ein Importer wandelt eine fremde Infrastrukturbeschreibung in Aggrega-Entitäten um: Er liest die Quellbytes für ein benanntes Format, bildet jeden Quellknoten auf eine Katalogentität ab und gibt die Entitäten zurück, die er ausgegeben hat, die Abbildungsentscheidungen, die er getroffen hat, alle Diagnosen, die er ausgelöst hat, und alle Scaffold-Dateien, die er erzeugt hat. Ein Importer deklariert die Formate, die er verarbeitet, als import:-Fähigkeiten in seinem Deskriptor. Der Importer bildet Bedeutung aus der Quelle auf Entitäten ab; der Compiler reicht die ausgegebenen Entitäten opak durch.

Eine der folgenden Formen

  • ImportInput
  • ImportOutput

Definitionen

ImportInput

Die Payload, die ein Importer-Guest erhält: das Quellformat, das auswählt, wie die Bytes zu lesen sind, die primären Quellbytes und der Name der Datei, aus der sie gelesen wurden, alle benannten Quellen für einen Import aus mehreren Dateien, ein optionales opakes Optionsdokument, das der Konsument für importerspezifisches Verhalten liefert, eine Sicht auf die Components, die der Katalog des Workspace enthält, und das Ziel, für das der Import Entwürfe erstellt.

EigenschaftTypErforderlichBeschreibung
formatstringjaDer Name des zu importierenden Quellformats, passend zu einer der angekündigten import:-Fähigkeiten des Importers. Der Importer liest die Quellen in diesem Format.
bytesstringjaDie zu importierenden primären Quellbytes, die der Importer im benannten Format liest: die ganze Datei, wo die Quelle des Imports eine Datei ist, und leer, wo sie ein Verzeichnis ist, dessen Dateien stattdessen als benannte Quellen ankommen. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er ein String ist, den der Importer dekodiert, um sie wiederherzustellen — und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt.
namestringneinDer Name der Quelle des Imports, ohne vorangestelltes Verzeichnis, damit ein Importer die Quelle in dem nennen kann, was er meldet und was er entwirft. Ist die Quelle eine einzelne Datei, ist es der Basisname der Datei: Die primären Bytes kommen nicht als benannte Quelle an, daher ist dies der einzige Name, den sie tragen. Ist die Quelle ein Verzeichnis, ist es der Basisname des Verzeichnisses, und die Dateien des Verzeichnisses kommen weiterhin als benannte Quellen an, jede unter ihrem eigenen Namen, bei leeren primären Bytes. Fehlt, wo die Quelle keinen Namen zu geben hat.
sourcesImportSource[]neinBenannte Quellen, jede mit ihren eigenen Bytes, in einer einzigen, nach Namen sortierten Liste. Wo die Quelle des Imports ein Verzeichnis ist, gibt es eine pro Datei darin, die die deklarierten Dateimuster des Importers auswählen, benannt nach ihrem durch Schrägstriche getrennten Pfad innerhalb des Verzeichnisses. Die Dateien, die die Anbindung, die den Importer konfiguriert, unter with.sources deklariert, werden ebenfalls hier getragen, jede unter ihrem Basisnamen, und der Host lehnt einen Import ab, in dem eine aus dem Verzeichnis gelesene Datei und eine dieser Dateien denselben Namen tragen. Fehlt, wo keines von beiden welche liefert.
settingsanyneinEin opakes Importoptionsdokument, das der Konsument für importerspezifisches Verhalten liefert. Der Host reicht es durch, ohne es zu interpretieren; der Importer liest jede Form, die er dokumentiert. Fehlt, wenn der Konsument keine Optionen liefert.
catalogCatalogProjectionneinEine Sicht auf die Components, die der eigene Katalog des Workspace enthält — der Katalog, aus dem der Importer selbst ausgewählt wurde —, damit der Importer sie als Kandidaten abwägen kann, wenn er einen Quellknoten auf eine Katalogentität abbildet. Der Host erstellt sie allein aus diesem lokalen Katalog, und sie trägt nur Namen, Versionen, Labels und deklarierte Struktur: niemals einen Wert, einen Standardwert oder ein Secret. Ihre Reihenfolge ist fest, sodass ein Katalog eine einzige Bytefolge ergibt. Fehlt, wenn der Katalog keine Component enthält.
targetstringneinDie Anbieterfähigkeit, für die der Import Entwürfe erstellt, etwa compose oder helm: das Ziel, das dem Import übergeben wurde, oder, bei einem Import, der einen früheren aktualisiert und selbst keines nennt, das Ziel, das dieser frühere Import festgehalten hat. Ein Importer schreibt das, was nur dieses Ziel benötigt, als Deklarationen in die Entwürfe und lässt weg, was nur ein anderes Ziel benötigt. Der Host reicht es unverändert durch, nachdem er geprüft hat, dass ein Recipe des Katalogs des Workspace daran bindet. Fehlt, wenn der Import kein Ziel nennt.

Zusätzliche Eigenschaften sind nicht zulässig.

CatalogProjection

Der Katalog des Workspace, wie ein Importer ihn sieht: ein Eintrag pro Component, die der Katalog enthält, jeder mit den Metadaten, die ein Importer abwägt, wenn er einen Kandidaten bewertet.

EigenschaftTypErforderlichBeschreibung
componentsCatalogComponent[]jaEin Eintrag pro Component-Name, den der Katalog enthält, nach Namen sortiert. Wo der Katalog mehrere Versionen einer Component enthält, beschreibt ihr Eintrag die Version, zu der eine Referenz auflöst, die die Component ohne Version nennt.

Zusätzliche Eigenschaften sind nicht zulässig.

CatalogComponent

Eine Component des Katalogs des Workspace: ihr Name und ihre Version, ihre Labels, die Schlüsselnamen, die ihre values und provides deklarieren, und die Sockets, die sie für ihre Abhängigkeiten deklariert. Eine Component, die eine andere erweitert, trägt das, was sie erbt, ebenso wie das, was sie selbst deklariert.

EigenschaftTypErforderlichBeschreibung
namestringjaDer Name der Component, wie ihr metadata.name ihn deklariert — der Name, unter dem ein Aggregate sie referenziert.
versionstringjaDie Version der Component, wie ihr metadata.version sie deklariert.
labelsMap von stringneinDie Labels der Component, als String-zu-String-Map. Fehlt, wenn sie keine trägt.
valuesstring[]neinDie Schlüsselnamen der obersten Ebene, die die values der Component deklarieren, sortiert. Nur eine Liste von Namen: Sie trägt niemals einen Wert oder einen Standardwert. Fehlt, wenn ihre values keinen Schlüssel deklarieren.
providesstring[]neinDie Schlüsselnamen der obersten Ebene, die die provides der Component deklarieren, sortiert. Nur eine Liste von Namen: Sie trägt niemals einen Wert. Fehlt, wenn ihre provides keinen Schlüssel deklarieren.
socketsCatalogSocket[]neinDie Sockets, die die Component für ihre Abhängigkeiten deklariert, in Deklarationsreihenfolge: Bei einer Component, die eine andere erweitert, kommen die geerbten Sockets zuerst, in der Reihenfolge, in der die erweiterte Component sie deklariert, gefolgt von denen, die sie hinzufügt. Fehlt, wenn sie keine deklariert.

Zusätzliche Eigenschaften sind nicht zulässig.

CatalogSocket

Ein Socket, den eine Katalog-Component für ihre Abhängigkeiten deklariert: der Name des Sockets und der Label-Selektor, den eine über ihn verdrahtete Abhängigkeit erfüllen muss.

EigenschaftTypErforderlichBeschreibung
namestringjaDer Name des Sockets, wie das usesSchema der Component ihn deklariert.
selectorstringjaDer Label-Selektor des Sockets, wörtlich, in der Kubernetes-artigen Grammatik, in der die Component ihn schreibt: die Labels, die eine über diesen Socket verdrahtete Abhängigkeit tragen muss.

Zusätzliche Eigenschaften sind nicht zulässig.

ImportSource

Eine benannte Quelle innerhalb eines Imports aus mehreren Dateien oder aus einem Verzeichnis: ein Name, der die Quelle verortet, und ihre eigenen Bytes.

EigenschaftTypErforderlichBeschreibung
namestringjaDer Name dieser Quelle innerhalb des Imports, etwa ein relativer Dateipfad.
bytesstringjaDie Bytes dieser Quelle. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er ein String ist, den der Importer dekodiert, um sie wiederherzustellen — und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt.

Zusätzliche Eigenschaften sind nicht zulässig.

ImportOutput

Die Payload, die ein Importer-Guest zurückgibt: die Entitäten, die der Import erzeugt hat, die Abbildungsentscheidungen dahinter, alle Diagnosen, die der Import ausgelöst hat, und alle Scaffold-Dateien, die er erzeugt hat. Jedes Feld ist optional, sodass ein Import, der nichts aufgelöst hat, allein Diagnosen zurückgeben kann.

EigenschaftTypErforderlichBeschreibung
entitiesEmittedEntity[]neinDie Entitäten, die der Import erzeugt hat, jede entweder eine Referenz auf eine vorhandene Katalogentität oder ein entworfener Entitätsrumpf. Fehlt, wenn der Import keine Entitäten ausgegeben hat.
decisionsImportDecision[]neinDie Abbildungsentscheidungen, die der Import getroffen hat, eine pro aufgelöstem Quellknoten, mit den abgewogenen Kandidaten und der getroffenen Wahl. Fehlt, wenn der Import keine Entscheidungen aufgezeichnet hat.
diagnosticsDiagnostic[]neinDiagnosen, die der Import ausgelöst hat — zum Beispiel ein nicht aufgelöster Quellknoten oder eine mehrdeutige Abbildung. Fehlt, wenn der Import keine erzeugt hat.
filesScaffoldFile[]neinScaffold-Dateien, die der Import neben den Entitäten erzeugt hat, etwa ein Start-Aggregat oder eine Readme. Fehlt, wenn der Import keine Dateien erzeugt hat.
errorstringneinEine Fehlermeldung, die gesetzt wird, wenn der Guest lief, die Operation aber nicht abschließen konnte; fehlt bei Erfolg. Sie ist von allen Diagnosen getrennt, die die Ausgabe trägt: Diagnosen melden Probleme, die während eines Laufs gefunden wurden, der dennoch ein Ergebnis erzeugt hat, während error meldet, dass die Operation selbst nicht abgeschlossen wurde. Der Host meldet einen vorhandenen Fehler als fehlgeschlagenen Plugin-Aufruf.

Zusätzliche Eigenschaften sind nicht zulässig.

EmittedEntity

Eine Entität, die der Import erzeugt hat: ihre Art, ihr Name und wie sie ausgegeben wird — eine Referenz auf eine vorhandene Katalogentität oder ein neu entworfener Entitätsrumpf.

EigenschaftTypErforderlichBeschreibung
kindstringjaDie Art der ausgegebenen Entität. Die Kern-Importer geben Component, Aggregate und Release aus; ein Leser toleriert jede andere Art.
namestringjaDer Name der ausgegebenen Entität.
modestring (enum)jaWie die Entität ausgegeben wird: reference verweist über ihren Namen auf eine vorhandene Katalogentität, und draft trägt einen neu entworfenen Entitätsrumpf. Zulässige Werte: "reference", "draft"
bodystringneinDer rohe YAML-Rumpf einer entworfenen Entität. Leer bei einer reinen Referenz, die eine vorhandene Entität nennt, statt eine zu entwerfen.
labelsMap von stringneinLabels, die an die ausgegebene Entität angehängt werden, als String-zu-String-Map. Die Kern-Importer lassen sie leer.
annotationsMap von stringneinAnnotationen, die an die ausgegebene Entität angehängt werden, als String-zu-String-Map. Die Kern-Importer lassen sie leer.
sourceRefstringneinEine Referenz auf den Quellknoten, aus dem diese Entität ausgegeben wurde, damit ein Leser die Entität bis zu ihrem Ursprung in der importierten Quelle zurückverfolgen kann.
decisionRefstringneinEine Referenz auf die Abbildungsentscheidung, die diese Entität erzeugt hat, die sie mit den abgewogenen Kandidaten und der getroffenen Wahl verknüpft.

Zusätzliche Eigenschaften sind nicht zulässig.

ImportDecision

Eine Abbildungsentscheidung: der Quellknoten, den der Importer aufgelöst hat, die Kandidaten-Katalogentitäten, die er abgewogen hat, der Kandidat, den er gewählt hat, und die Begründung hinter der Wahl.

EigenschaftTypErforderlichBeschreibung
sourceNodeDecisionSourceNodejaDer Quellknoten, den diese Entscheidung aufgelöst hat: der Knoten, den der Importer aus der Quelle gelesen und auf eine Katalogentität abgebildet hat.
candidatesImportCandidate[]neinDie Kandidaten-Katalogentitäten, die der Importer für diesen Quellknoten abgewogen hat, jede mit ihrer Punktzahl und der Aufschlüsselung pro Signal hinter dieser Punktzahl. Fehlt, wenn der Importer keine Kandidaten abgewogen hat.
chosenDecisionChoiceneinDer Kandidat, den der Importer für diesen Quellknoten gewählt hat, und wie er ihn ausgegeben hat. Fehlt, wenn der Importer keine Wahl getroffen hat.
rationalestringneinEine für Menschen lesbare Erklärung, warum der Importer diese Wahl getroffen hat.
swapHintstringneinEin Hinweis, der beschreibt, wie die gewählte Abbildung gegen eine Alternative ausgetauscht werden kann, damit ein Leser die Entscheidung überarbeiten kann.

Zusätzliche Eigenschaften sind nicht zulässig.

DecisionSourceNode

Der Quellknoten, den eine Abbildungsentscheidung aufgelöst hat: ein Bezeichner, der Typ, unter dem die Quelle ihn nennt, und eine für Menschen lesbare Zusammenfassung seiner Parameter.

EigenschaftTypErforderlichBeschreibung
idstringjaDer Bezeichner des Quellknotens innerhalb der importierten Quelle.
typestringjaDer Typ des Quellknotens, wie die Quelle ihn nennt.
paramsSummarystringjaEine für Menschen lesbare Zusammenfassung der Parameter des Quellknotens, zur Anzeige neben der Entscheidung.

Zusätzliche Eigenschaften sind nicht zulässig.

ImportCandidate

Eine Kandidaten-Katalogentität, die der Importer für einen Quellknoten abgewogen hat: die Kandidatenkomponente, ihre Gesamtpunktzahl, die Übereinstimmungsstufe, in die die Punktzahl fällt, und die Aufschlüsselung pro Signal hinter der Punktzahl.

EigenschaftTypErforderlichBeschreibung
componentNamestringjaDer Name der Kandidatenkomponente im Katalog.
scorenumberjaDie Gesamtpunktzahl der Übereinstimmung des Kandidaten, aggregiert aus der Aufschlüsselung pro Signal.
tierstringjaDie Übereinstimmungsstufe, in die der Kandidat fällt, ein grobes Band über der Punktzahl.
signalsCandidateSignalsjaDie Aufschlüsselung pro Signal hinter der Punktzahl des Kandidaten.

Zusätzliche Eigenschaften sind nicht zulässig.

CandidateSignals

Die Aufschlüsselung pro Signal hinter der Punktzahl eines Kandidaten: ein Beitrag pro übereinstimmendem Signal. Ein Objekt mit festen Feldern, sodass die Menge der Signale stabil und das Übertragungsformat deterministisch ist.

EigenschaftTypErforderlichBeschreibung
tablenumberjaDer Punktbeitrag des Signals der Abbildungstabelle.
categorynumberjaDer Punktbeitrag des Kategoriesignals.
domainLabelsnumberjaDer Punktbeitrag des Signals der Domänen-Labels.
shapenumberjaDer Punktbeitrag des Formsignals.
namenumberjaDer Punktbeitrag des Namenssignals.

Zusätzliche Eigenschaften sind nicht zulässig.

DecisionChoice

Der Kandidat, den eine Abbildungsentscheidung gewählt hat: die Ziel-Katalogentität, wie sie ausgegeben wird, und die Übereinstimmungsstufe der Wahl.

EigenschaftTypErforderlichBeschreibung
targetstringjaDer Name der gewählten Ziel-Katalogentität.
modestringjaWie das gewählte Ziel ausgegeben wird, analog zum Modus einer ausgegebenen Entität: eine Referenz auf eine vorhandene Entität oder ein neu entworfener Rumpf.
tierstringjaDie Übereinstimmungsstufe des gewählten Ziels.

Zusätzliche Eigenschaften sind nicht zulässig.

ScaffoldFile

Eine Scaffold-Datei, die der Import erzeugt hat: ein Pfad relativ zur Ausgabewurzel des Imports und der Inhalt der Datei.

EigenschaftTypErforderlichBeschreibung
pathstringjaDer Pfad der Scaffold-Datei, relativ zur Ausgabewurzel des Imports.
contentstringjaDer Inhalt der Scaffold-Datei.

Zusätzliche Eigenschaften sind nicht zulässig.