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

Aggrega-Schema für den Wasm-Socket des FeatureRecipe-Pipeline-Schritts

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

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

Die Übertragungsformen, die ein Plugin-Socket für feature-recipe-Pipeline-Schritte verarbeitet (FRPStepInput) und ausgibt (FRPStepOutput). Ein FRP-Schritt läuft pro Inline-Pipeline-Eintrag, der in einem Recipe oder FeatureRecipe deklariert ist: Der Host übergibt dem Schritt die schlüsselbasierte Dokumentmenge als Ganzes, der Schritt wählt die Dokumente, auf die er abzielt, anhand ihres Inhalts aus und gibt über Schlüssel adressierte RFC-6902-Patches sowie Nebeneffekte und Diagnosen zurück. Dies ist ein anderer Guest-Vertrag als die Rolle label-transform, die einmal über den gesamten Topologiegraphen läuft und opake Label-Patches zurückgibt. Die Payload-Typen für Go, Rust und TypeScript werden aus diesem Schema in die Plugin-ABI-Pakete generiert, sodass die drei Sprachen dasselbe Übertragungsformat lesen und schreiben; ein Guest importiert sie aus diesen Paketen oder über sein Plugin-Kit, wo das Kit sie re-exportiert.

Eine der folgenden Formen

  • FRPStepInput
  • FRPStepOutput

Definitionen

FRPStepInput

Die Payload, die ein Guest der feature-recipe-Pipeline für einen Pipeline-Schritt erhält: die schlüsselbasierte Dokumentmenge, die der Host als Ganzes übergibt, die schrittlokale Eingabe, die das Recipe für diesen Schritt deklariert hat, den Kontext zur Render-Zeit, die Position des Schritts in der Pipeline und einen Nachweis der bereits gelaufenen Schritte.

EigenschaftTypErforderlichBeschreibung
documentsDocumentSetjaDie schlüsselbasierte, in einem Geltungsbereich verwurzelte Menge adressierbarer Einheiten, die ein Pipeline-Guest als seine Eingabeoberfläche erhält. Der Host übergibt die ganze Menge und interpretiert ihren Inhalt nicht; der Guest wählt die Dokumente, auf die er abzielt, anhand ihres Inhalts aus und adressiert seine Patches über Schlüssel.
step_inputobjectneinDer gerenderte with-Block des Schritts, eine Schlüsselmenge in Autorenreihenfolge, die der Guest als seine schrittlokale Eingabe liest. Bewahrt die Autorenreihenfolge, sodass die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist.
contextobjectjaDer Kontext zur Render-Zeit, den der Host dem Schritt übergibt, getragen als die Bytes seines JSON-Dokuments; dieses Schema lässt das Objekt undeklariert, und der Host liest nichts daraus zurück. Ein Schritt eines Recipe oder eines FeatureRecipe mit Komponenten-Geltungsbereich erhält parameters, die Parameterwerte des Release, nach Namen sortiert und fehlend, wenn es keine gibt; annotations, die Annotationen des Knotens, aufgeteilt danach, wo jede geschrieben wurde, in aggregate, release und catalog, jeweils fehlend, wenn leer; und boundary, die Boundary, in der der Knoten liegt: name, path (ihre Segmente), sync_wave (fehlend, wenn 0), directory, sub_directory (fehlend, wenn es keines gibt) und annotations (die Menge, die die Boundaries des Release bis zum Knoten kaskadieren, wobei sein eigener Release-Eintrag zuletzt darübergelegt wird; fehlend, wenn leer). Ein Schritt eines FeatureRecipe mit Boundary-Geltungsbereich, das keine Host-Komponente hat, erhält parameters; annotations, das allein den release-Bucket trägt, der die eigene Annotationsmenge der Boundary ist; und ein boundary, das seinen name, seinen path und dieselbe Menge als seine annotations trägt. Das Provider-Rendering desselben FeatureRecipe erhält denselben Kontext. Die Einrückungsbreite, yaml_indent, wird für einen Schritt nicht gesetzt.
step_indexintegerjaDie nullbasierte Position dieses Schritts in der Pipeline.
preceding_stepsPrecedingStep[]neinDie Pipeline-Schritte, die vor diesem Schritt liefen, sodass ein Guest untersuchen kann, was ihm vorausging.

Zusätzliche Eigenschaften sind nicht zulässig.

FRPStepOutput

Die Payload, die ein Guest der feature-recipe-Pipeline für einen Pipeline-Schritt zurückgibt: die RFC-6902-Patches, die der Host auf die schlüsselbasierte Dokumentmenge anwendet, die Nebeneffekte, die dieser Schritt erzeugt hat, und alle Diagnosen, die der Guest ausgelöst hat.

EigenschaftTypErforderlichBeschreibung
patchesJSONPatchOp[]neinStrukturierte RFC-6902-Operationen, die der Schritt gegen Dokumente in der schlüsselbasierten Menge ausgibt. Jede nennt ihr Zieldokument über scope und key und nennt dann op, path und value explizit. Verschieden von der opaken Patch-Liste der Rolle label-transform: Die Patches eines FRP-Schritts werden vom Host angewendet und bei einem fehlgeschlagenen Schritt per Snapshot wiederhergestellt, daher sind die Operationen hier explizit statt opak.
side_effectsSideEffect[]neinDie Effekte, die dieser Schritt über das Patchen eines vorhandenen Dokuments hinaus erzeugt hat (zum Beispiel das Ausgeben einer CRD oder das Schreiben einer Datei).
diagnosticsDiagnostic[]neinDiagnosen, die der Guest ausgelöst hat. Jedes Element ist die gemeinsame Diagnoseform der Wasm-Plugins.
outputsobjectneinDie adressierbaren Ausgaben, die der Guest für diesen Schritt zurückgibt, eine Schlüsselmenge in Autorenreihenfolge, die die Ausgaben des Schritts befüllt, damit ein späterer Schritt oder ein Template sie liest. Bewahrt die Autorenreihenfolge, sodass die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist. Fehlt, wenn der Schritt keine Ausgaben zurückgibt.
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.

DocumentSet

Die schlüsselbasierte, in einem Geltungsbereich verwurzelte Menge adressierbarer Einheiten, die ein Pipeline-Guest als seine Eingabeoberfläche erhält. Der Host übergibt die ganze Menge und interpretiert ihren Inhalt nicht; der Guest wählt die Dokumente, auf die er abzielt, anhand ihres Inhalts aus und adressiert seine Patches über Schlüssel.

EigenschaftTypErforderlichBeschreibung
ownMap von UnitjaDie eigene gerenderte Ausgabe des Knotens, indiziert nach Einheiten-Token. Bewahrt die Schlüsselreihenfolge, sodass die Menge das Übertragungsformat in einer stabilen Reihenfolge erreicht und die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist.
hostMap von UnitneinDie gerenderte Ausgabe der Komponente, an die ein FeatureRecipe mit Komponenten-Geltungsbereich angebunden ist — die entitätsübergreifende Oberfläche. Fehlt bei Recipe-Schritten und bei FeatureRecipe-Schritten mit Boundary-Geltungsbereich, die keine Host-Komponente haben. Bewahrt die Schlüsselreihenfolge, sodass die Menge das Übertragungsformat in einer stabilen Reihenfolge erreicht und die Payload über Läufe mit identischer Eingabe hinweg byte-identisch ist.

Zusätzliche Eigenschaften sind nicht zulässig.

Unit

Ein adressierbares Stück, in das sich die erzeugte Ausgabe eines Providers aufteilt — die hybride Sicht auf ein Stück Ausgabe. Eine strukturierte Einheit trägt einen Baum (eine nach RFC 6902 adressierbare Sicht) und ist ein PATCH-Ziel; eine opake Einheit trägt nur ihren Medientyp und ihre Bytes (keinen Baum) und ist ein SELECT- und EMIT-Ziel, aber kein PATCH-Ziel.

EigenschaftTypErforderlichBeschreibung
tokenstringjaDie opake Positionsadresse, die der Codec vergibt — der ausgegebene Dateiname bei einer Datei mit einem einzigen Dokument oder <filename>#<ordinal> (Dateireihenfolge), wenn eine Datei mehrere Dokumente trägt. Der Guest behandelt sie als opak: Er wählt eine Einheit anhand ihres Inhalts aus und gibt das Token unverändert zurück, ohne es je zu parsen.
bytesstringneinDie ursprünglichen Bytes der Einheit, die Quelle des Wiederzusammensetzens. Das Wiederzusammensetzen ist konstruktionsbedingt bytegetreu: Unberührte Bytes werden wörtlich aus diesen wieder zusammengefügt. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er eine Zeichenkette ist, die der Schritt dekodiert, um sie zurückzugewinnen —, und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt.
media_typestringneinDer Inhaltstyp der Einheit (zum Beispiel application/yaml für den mitgelieferten YAML-Codec), damit der Guest weiß, was er vor sich hat.
treeanyneinDie nach RFC 6902 adressierbare normalisierte Sicht der Einheit, wenn der Codec eine erzeugt hat, oder fehlend, wenn nicht. Eine Einheit mit Baum ist strukturiert (ein PATCH-Ziel); eine Einheit ohne Baum ist opak. Das Dokument ist für den Host opak, der die Bytes durchreicht, ohne sie zu interpretieren, sodass der Baum auf dieser Schemaebene jeden beliebigen JSON-Wert trägt.

Zusätzliche Eigenschaften sind nicht zulässig.

JSONPatchOp

Eine JSON-Patch-Operation nach RFC 6902, die ein FRP-Schritt gegen ein Dokument in der schlüsselbasierten Menge ausgibt. Scope und key nennen das Zieldokument; op, path, value und from tragen die Operation gegen einen Ort innerhalb dieses Dokuments.

EigenschaftTypErforderlichBeschreibung
scopestring (enum)jaDie Dokumentwurzel, auf die die Operation abzielt: own (die eigenen gerenderten Dokumente des Knotens) oder host (die Dokumente der Komponente, an die ein FeatureRecipe mit Komponenten-Geltungsbereich angebunden ist). Zulässige Werte: "own", "host"
keystringjaDer Schlüssel des ausgegebenen Dateinamens innerhalb der genannten Wurzel — der Schlüssel, den der Guest zur Laufzeit aus dem Dokument erfahren hat, das er anhand des Inhalts ausgewählt hat.
opstringjaDie RFC-6902-Operation: eine von add, remove, replace, move, copy, test.
pathstringjaEin JSON Pointer nach RFC 6901 auf den Zielort innerhalb des genannten Dokuments.
valueanyneinDer Operand für add, replace und test, andernfalls weggelassen. Ein beliebiges JSON-Dokumentfragment, das der Guest verfasst hat und das der Host opak durchreicht; es trägt auf dieser Schemaebene jeden beliebigen JSON-Wert.
fromstringneinDer Quellzeiger für move und copy, andernfalls weggelassen.

Zusätzliche Eigenschaften sind nicht zulässig.

SideEffect

Ein Effekt, den ein Schritt der feature-recipe-Pipeline über das Patchen eines vorhandenen Dokuments hinaus erzeugt. Kind ist emit_crd oder emit_file; das Schema belässt es als offenen String, damit eine neue Art ohne ABI-Bruch hinzugefügt werden kann, und ein Build hält bei jeder anderen Art an. Wenn kind emit_crd ist, trägt crd das CRD-Dokument und file wird weggelassen; wenn kind emit_file ist, trägt file die zu schreibende Datei und crd wird weggelassen.

EigenschaftTypErforderlichBeschreibung
kindstringjaDie Art des Effekts: emit_crd oder emit_file. Das Schema belässt das Feld als offenen String, damit eine neue Art ohne ABI-Bruch hinzugefügt werden kann; ein Build hält bei jeder anderen Art an und nennt dabei den Knoten, den Nebeneffekt und die Art.
scopestring (enum)neinDie Dokumentwurzel, zu der die Emission beiträgt: own (die eigene Menge des Knotens) oder host (die Menge der angebundenen Host-Komponente). Ein fehlendes scope bedeutet own zum Zeitpunkt der Anwendung. Zulässige Werte: "own", "host"
crdanyneinDas CRD-Dokument, das der Schritt ausgibt, wenn kind emit_crd ist. Für den Host opak, der es durchreicht, ohne es zu interpretieren; es trägt auf dieser Schemaebene jeden beliebigen JSON-Wert.
fileSideEffectFileneinDie Datei, die ein emit_file-Nebeneffekt schreibt: der Zielpfad und der Dateiinhalt.

Zusätzliche Eigenschaften sind nicht zulässig.

SideEffectFile

Die Datei, die ein emit_file-Nebeneffekt schreibt: der Zielpfad und der Dateiinhalt.

EigenschaftTypErforderlichBeschreibung
pathstringjaDer Zielpfad, in den die Datei geschrieben wird.
contentstringjaDer zu schreibende Dateiinhalt.

Zusätzliche Eigenschaften sind nicht zulässig.

PrecedingStep

Ein Pipeline-Schritt, der vor dem aktuellen Schritt ausgeführt wurde, damit ein Guest untersuchen kann, was ihm vorausging: der Pipeline-Index des Schritts, das Plugin, das er genannt hat, und die Nebeneffekte, die dieser Schritt ausgegeben hat.

EigenschaftTypErforderlichBeschreibung
indexintegerjaDie nullbasierte Position des vorangehenden Schritts in der Pipeline.
plugin_uristringjaDas Plugin, das der vorangehende Pipeline-Eintrag in seinem Feld plugin nennt, so wie es geschrieben ist.
side_effectsSideEffect[]neinDie Nebeneffekte, die der vorangehende Schritt ausgegeben hat.

Zusätzliche Eigenschaften sind nicht zulässig.