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

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

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

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

Die Übertragungsformen, die ein in einer Urteilsrolle angebundenes Governance-Plugin verarbeitet — PolicyInput in der Rolle ir-verdict, RenderPolicyInput in der Rolle render-verdict — und ausgibt (PolicyOutput). Ein Urteil mit Schweregrad halt hält den Build mit einer Build-Zeit-Diagnose an; ein Urteil warn oder info wird gemeldet, und der Build läuft weiter. Der Eingabegraph der IR-Stufe ist der vollständige, gegenüber Fähigkeiten agnostische IR-Graph, referenziert aus ir-v1beta1.schema.json statt hier erneut deklariert, sodass das Richtlinien-Plugin dieselben Details zu Knoten, Kanten und Anbindungen sieht wie der Compiler; Plugin-Autoren verfolgen die Version des IR-Schemas. Die Eingabe der Render-Stufe trägt statt des Graphen die gerenderten Ausgabedateien. 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

  • PolicyInput
  • RenderPolicyInput
  • PolicyOutput

Definitionen

PolicyInput

Die Payload, die die statische Analyse an den Richtlinien-Socket übergibt: der vollständige IR-Graph (dieselbe Form, die der Topology Builder ausgibt) plus die vorab berechneten Routing-Pfade, die der Analysator daneben aufzählt.

EigenschaftTypErforderlichBeschreibung
graphIRGraphjaDer vollständige, gegenüber Fähigkeiten agnostische IR-Graph, mit einziger Quelle in ir-v1beta1.schema.json. Das Richtlinien-Plugin wertet die vollständigen Details zu Knoten, Kanten und Anbindungen aus statt einer schmalen Projektion.
precalculated_pathsPrecalculatedPath[]jaRouting-Pfade, die der Analysator vorab aufgezählt hat, damit Richtlinien Schlüsse über die Erreichbarkeit ziehen können, ohne den Graphen erneut zu durchlaufen.
sourcesPolicySource[]neinDefinitionsdateien, die der Host zur Kompilierzeit liest und dem Plugin unverändert übergibt, als nach Pfad sortierte geordnete Liste. Der Host liest die Bytes als opaken Inhalt und parst sie nicht. Fehlt, wenn die Anbindung keine Quellen deklariert.
settingsobjectneinEin Freiform-Einstellungsobjekt, das der Host wörtlich an das Plugin übergibt. Der Host parst seinen Inhalt nicht und handelt nicht danach. Fehlt, wenn die Anbindung keine Einstellungen deklariert.

Zusätzliche Eigenschaften sind nicht zulässig.

PolicyOutput

Die Antwortform, die das Richtlinien-Plugin ausgibt: die Urteile, die während der Auswertung ausgelöst wurden, eine Diagnose pro ausgelöstem Urteil. Eine erlaubende Regel gibt nichts aus, sodass ein leeres results-Array bedeutet, dass keine Urteile ausgelöst wurden.

EigenschaftTypErforderlichBeschreibung
resultsDiagnostic[]jaDie ausgelösten Urteile, jeweils eine Diagnose, in der Reihenfolge, in der das Plugin sie ausgibt. Leer, wenn kein Urteil ausgelöst wurde.
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.

RenderPolicyInput

Die Payload, die ein in der Rolle render-verdict angebundenes Governance-Plugin erhält: die gerenderten Ausgabedateien, die die Richtlinie auswertet, anstelle des IR-Graphen.

EigenschaftTypErforderlichBeschreibung
artifactsRenderedArtifact[]jaDie gerenderten Ausgabedateien, die die Richtlinie auswertet, als nach Pfad sortierte geordnete Liste, sodass das Übertragungsformat über Läufe mit identischer Eingabe hinweg byte-identisch ist.
sourcesPolicySource[]neinDefinitionsdateien, die der Host zur Kompilierzeit liest und dem Plugin unverändert übergibt, als nach Pfad sortierte geordnete Liste. Der Host liest die Bytes als opaken Inhalt und parst sie nicht. Fehlt, wenn die Anbindung keine Quellen deklariert.
settingsobjectneinEin Freiform-Einstellungsobjekt, das der Host wörtlich an das Plugin übergibt. Der Host parst seinen Inhalt nicht und handelt nicht danach. Fehlt, wenn die Anbindung keine Einstellungen deklariert.

Zusätzliche Eigenschaften sind nicht zulässig.

RenderedArtifact

Eine gerenderte Ausgabedatei: ihr Pfad und der gerenderte Inhalt an diesem Pfad.

EigenschaftTypErforderlichBeschreibung
pathstringjaDer Ausgabepfad der gerenderten Datei, relativ zur Render-Wurzel.
contentstringjaDer gerenderte Inhalt an diesem Pfad.
treeanyneinDer geparste strukturierte Baum dieses Artefakts, vorhanden, wenn der Host den Inhalt geparst hat, bevor er ihn an das Plugin übergab — die kanonische JSON-Sicht auf ein Quellformat, das das Plugin nicht nativ liest (zum Beispiel ein nach JSON geparstes HCL-Artefakt). Die oberste Ebene kann ein Objekt, ein Array oder ein Skalar sein, entsprechend der eigenen Form des geparsten Dokuments. Fehlt, wenn der Host das Artefakt nicht geparst hat; in diesem Fall liest das Plugin den nativen Inhalt direkt. Der Host reicht den Baum opak durch und trägt ihn unverändert, ohne seinen Inhalt zu interpretieren.
formatstringneinDas Format, in dem das Artefakt gerendert wurde, vorhanden, wenn der erzeugende Provider es deklariert hat. Fehlt, wenn der erzeugende Provider kein Format deklariert hat.

Zusätzliche Eigenschaften sind nicht zulässig.

PolicySource

Eine an das Plugin übergebene Definitionsdatei: ihr Basisnamenpfad und der Inhalt der Datei. Beides wird wörtlich getragen; der Host parst den Inhalt nicht.

EigenschaftTypErforderlichBeschreibung
pathstringjaDer Basisname der Quelldatei. Der Host liefert nur den Basisnamen, nie einen absoluten Host-Pfad, sodass das Übertragungsformat portabel und deterministisch ist.
contentstringjaDer Inhalt der Quelldatei, wörtlich als opake Zeichenkette getragen.

Zusätzliche Eigenschaften sind nicht zulässig.

PrecalculatedPath

Ein vorab aufgezählter Routing-Pfad, den der Analysator materialisiert, damit Richtlinienregeln Schlüsse über die Erreichbarkeit ziehen können, ohne den Graphen erneut zu durchlaufen.

EigenschaftTypErforderlichBeschreibung
path_idstringjaStabile Kennung für diesen Pfad; deterministisch über Läufe mit identischer Eingabe hinweg.
nodesstring[]jaGeordnete Folge der Knoten-IDs, die der Pfad durchläuft, von der Quelle bis zum Endpunkt.
attached_featuresstring[]jaAlphabetisch sortierte Vereinigung der Feature-Typ-URIs, die an einen beliebigen Knoten entlang des Pfads angebunden sind. Mengensemantik: Ein Feature erscheint einmal, auch wenn mehrere Knoten es tragen. Leer, wenn kein Knoten entlang des Pfads eine Feature-Anbindung trägt.

Zusätzliche Eigenschaften sind nicht zulässig.