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

Aggrega-Schema für den Wasm-Socket annotation-transform

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

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

Die Übertragungsformen, die ein in der Rolle annotation-transform angebundenes Governance-Plugin verarbeitet (AnnotationTransformInput) und ausgibt (AnnotationTransformOutput). Die Rolle läuft nach der Auflösung und vor der Annotations-Expansion: Das Plugin liest die aufgelösten Injektionsziele und die registrierten Bindungsschlüssel des Manifest und gibt eine Liste von Annotations-Injektionen zurück, die der Host auf diese Ziele anwendet, bevor die Expansion gebundene Annotationen in Feature-Anbindungen umwandelt. 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

  • AnnotationTransformInput
  • AnnotationTransformOutput

Definitionen

AnnotationTransformInput

Die Payload, die der Host dem annotation-transform-Plugin bei jedem Aufruf übergibt: die aufgelösten Injektionsziele mit ihren aktuellen Annotationen, die registrierten Annotations-Bindungsschlüssel des Manifest und die eigenen gepinnten Quellen und Einstellungen der Anbindung.

EigenschaftTypErforderlichBeschreibung
targetsAnnotationTarget[]jaDie Injektionsziele — die aufgelösten Komponenten, auf die das Plugin Annotationen injizieren darf, jede mit ihrer aktuellen Annotationsmenge, sodass das Plugin entscheiden kann, was es hinzufügt, ohne einen vorhandenen Schlüssel zu überschreiben. Vom Host deterministisch geordnet.
binding_keysstring[]jaDie Annotationsschlüssel, für die das Manifest eine Bindung registriert, in Autorenreihenfolge. Eine Injektion, deren Schlüssel registriert ist, expandiert zu einer Feature-Anbindung; das Plugin liest diese Liste, damit es nur Schlüssel injiziert, die gebunden werden. Der Host verlangt nicht, dass eine Injektion einen registrierten Schlüssel nennt — eine nicht registrierte injizierte Annotation verhält sich genau wie eine verfasste, nicht gebundene Annotation.
sourcesAnnotationSource[]neinDefinitionsdateien, die der Host liest und wörtlich an das Plugin übergibt, als geordnete, nach Pfad sortierte 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.

AnnotationTransformOutput

Die Antwortform, die das annotation-transform-Plugin ausgibt: eine Liste von Annotations-Injektionen, die der Host auf die genannten Ziele anwendet. Der Host wendet nur Annotations-Hinzufügungen an bestehenden Zielkoordinaten an, jede mit einem Wert, den ein Autor an dieser Annotation schreiben könnte — eine Zeichenkette oder ein Objekt aus Unterschlüsseln; eine Injektion, die eine nicht existierende Koordinate nennt oder einen Wert irgendeiner anderen Form trägt, hält den Build ausdrücklich an.

EigenschaftTypErforderlichBeschreibung
injectionsAnnotationInjection[]jaAnzuwendende Annotations-Injektionen, in Reihenfolge. Jede nennt eine bestehende Zielkoordinate sowie den Annotationsschlüssel und den Wert, die dort hinzugefügt werden.
errorstringneinEine Fehlermeldung, die gesetzt wird, wenn der Guest lief, die Operation aber nicht abschließen konnte; fehlt bei Erfolg. Der Host meldet einen vorhandenen Fehler als fehlgeschlagenen Plugin-Aufruf.

Zusätzliche Eigenschaften sind nicht zulässig.

AnnotationTarget

Ein aufgelöstes Injektionsziel, auf das das Plugin Annotationen injizieren darf: sein Boundary-Pfad und Komponentenname sowie die Annotationsmenge, die die Komponente bereits trägt.

EigenschaftTypErforderlichBeschreibung
boundary_pathstringjaDer durch Schrägstriche getrennte Boundary-Pfad, unter dem die Komponente im Release liegt.
component_namestringjaDer Name der Komponente innerhalb ihrer Boundary.
annotationsMap von string oder object oder nulljaDie Annotationen, die das Release an der Komponente selbst schreibt, geschlüsselt nach Annotationsschlüssel in der Reihenfolge, in der sie geschrieben sind. Jeder Wert ist das, was der Autor geschrieben hat: eine Zeichenkette, ein Objekt aus Unterschlüsseln in seiner eigenen geschriebenen Reihenfolge oder null, wo die Komponente eine Annotation abwählt, die sie sonst erben würde. Jeder Schlüssel ist unabhängig von seinem Wert vorhanden, sodass ein Plugin eine Annotation, die die Komponente bereits trägt, von einer unterscheiden kann, die sie nicht trägt, und nur hinzufügen kann, was fehlt.

Zusätzliche Eigenschaften sind nicht zulässig.

AnnotationInjection

Eine auf ein Ziel zu injizierende Annotation: die Zielkoordinate sowie der Annotationsschlüssel und sein Wert.

EigenschaftTypErforderlichBeschreibung
boundary_pathstringjaDer durch Schrägstriche getrennte Boundary-Pfad der Zielkomponente. Muss ein Ziel nennen, das der Host geliefert hat; eine unbekannte Koordinate hält den Build an.
component_namestringjaDer Name der Zielkomponente. Muss ein Ziel nennen, das der Host geliefert hat; eine unbekannte Koordinate hält den Build an.
annotation_keystringjaDer Annotationsschlüssel, der an der Zielkomponente hinzugefügt wird.
annotation_valuestring oder objectjaDer Wert der Annotation, als sein JSON getragen: eine Zeichenkette oder ein Objekt, dessen Schlüssel Unterschlüssel sind und dessen Einträge das sind, was ein Autor unter einem Unterschlüssel einer strukturierten Annotation schreiben darf. Der Host liest ihn genau so, wie er denselben an der Komponente im Release geschriebenen Wert liest, unter Beibehaltung der Schlüsselreihenfolge des Objekts, sodass ein Objekt eine Bindung speisen kann, die mehrere Unterschlüssel auf einmal leitet, während eine Zeichenkette eine Bindung speist, die einen leitet. Null, eine Liste, eine Zahl, ein Boolean und ein Objekt ohne Unterschlüssel werden unter Nennung der Injektion abgelehnt: Eine Injektion fügt eine Annotation hinzu und entfernt oder wählt nie eine ab.

Zusätzliche Eigenschaften sind nicht zulässig.

AnnotationSource

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.