Aggrega Wasm アノテーション変換ソケットのスキーマ
自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。
スキーマ ID: https://aggrega.ai/schemas/wasm-annotation-transform-v1beta1.schema.json
annotation-transform ロールにアタッチされたガバナンスプラグインが受け取るワイヤー形式(AnnotationTransformInput)と出力するワイヤー形式(AnnotationTransformOutput)です。このロールは解決の後、アノテーション展開の前に実行されます。プラグインは解決済みの注入対象と Manifest に登録されたバインディングキーを読み取り、アノテーション注入のリストを返します。ホストは、展開によってバインドされたアノテーションが Feature のアタッチメントに変換される前に、それらの注入を対象に適用します。Go、Rust、TypeScript のペイロード型はこのスキーマからプラグイン ABI パッケージに生成されるため、3 つの言語は 1 つのワイヤーを読み書きします。ゲストはそれらをこれらのパッケージから、またはプラグインキットが再エクスポートしている場合はプラグインキットを通じてインポートします。
次のいずれかの形
AnnotationTransformInputAnnotationTransformOutput
定義
AnnotationTransformInput
ホストが呼び出しのたびに annotation-transform プラグインに渡すペイロードです。現在のアノテーションを含む解決済みの注入対象、Manifest に登録されたアノテーションバインディングキー、およびアタッチメント自身の固定されたソースと設定を含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
targets | AnnotationTarget[] | はい | 注入対象です。プラグインがアノテーションを注入できる解決済みのコンポーネントであり、それぞれに現在のアノテーションセットが含まれるため、プラグインは既存のキーを上書きせずに何を追加するかを判断できます。ホストによって決定的な順序で並べられます。 |
binding_keys | string[] | はい | Manifest がバインディングを登録しているアノテーションキーで、作成者の記述順に並びます。キーが登録されている注入は Feature のアタッチメントに展開されます。プラグインはこのリストを読み取り、バインドされるキーだけを注入します。ホストは注入が登録済みのキーを指定することを要求しません。未登録の注入されたアノテーションは、作成者が記述したバインドされていないアノテーションとまったく同じように動作します。 |
sources | AnnotationSource[] | いいえ | ホストが読み取り、そのままプラグインに渡す定義ファイルで、パス順にソートされた順序付きリストです。ホストはバイト列を不透明な内容として読み取り、解析しません。アタッチメントがソースを宣言していない場合は存在しません。 |
settings | object | いいえ | ホストがそのままプラグインに渡す自由形式の設定オブジェクトです。ホストはその内容を解析せず、内容に基づいて動作もしません。アタッチメントが設定を宣言していない場合は存在しません。 |
追加のプロパティは許可されません。
AnnotationTransformOutput
annotation-transform プラグインが出力するレスポンスの形です。ホストが指定された対象に適用するアノテーション注入のリストです。ホストは、既存の対象座標へのアノテーション追加のみを適用し、各追加は作成者がそのアノテーションに記述できる値(文字列、またはサブキーのオブジェクト)を持ちます。存在しない座標を指定した注入、またはそれ以外の形の値を持つ注入は、ビルドを明示的に停止させます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
injections | AnnotationInjection[] | はい | 順に適用するアノテーション注入です。それぞれが既存の対象座標と、そこに追加するアノテーションキーおよび値を指定します。 |
error | string | いいえ | ゲストが実行されたものの操作を完了できなかったときに設定される失敗メッセージです。成功時には存在しません。ホストは、存在する error を失敗したプラグイン呼び出しとして示します。 |
追加のプロパティは許可されません。
AnnotationTarget
プラグインがアノテーションを注入できる解決済みの注入対象の 1 つです。境界パスとコンポーネント名、およびコンポーネントがすでに持っているアノテーションセットを含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
boundary_path | string | はい | Release 内でコンポーネントが配置されている、スラッシュ区切りの境界パスです。 |
component_name | string | はい | 境界内でのコンポーネントの名前です。 |
annotations | string、object、または null のマップ | はい | Release がコンポーネント自体に記述するアノテーションで、アノテーションキーをキーとし、記述された順に並びます。各値は作成者が記述したものです。文字列、記述された順のサブキーのオブジェクト、またはコンポーネントが本来継承するアノテーションをオプトアウトする場合は null です。値にかかわらずすべてのキーが存在するため、プラグインはコンポーネントがすでに持つアノテーションと持たないアノテーションを区別し、欠けているものだけを追加できます。 |
追加のプロパティは許可されません。
AnnotationInjection
対象に注入する 1 つのアノテーションです。対象座標と、アノテーションキーおよびその値を含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
boundary_path | string | はい | 対象コンポーネントのスラッシュ区切りの境界パスです。ホストが提供した対象を指定する必要があります。不明な座標はビルドを停止させます。 |
component_name | string | はい | 対象コンポーネントの名前です。ホストが提供した対象を指定する必要があります。不明な座標はビルドを停止させます。 |
annotation_key | string | はい | 対象コンポーネントに追加するアノテーションキーです。 |
annotation_value | string または object | はい | アノテーションの値で、その JSON として運ばれます。文字列、またはキーがサブキーであり、エントリが構造化アノテーションのサブキーの下に作成者が記述できるものであるオブジェクトです。ホストはこれを、Release でコンポーネントに記述された同じ値を読むのとまったく同じように読み、オブジェクトのキー順を保持します。そのため、オブジェクトは複数のサブキーを一度にルーティングするバインディングに、文字列は 1 つをルーティングするバインディングに供給できます。null、リスト、数値、ブール値、サブキーのないオブジェクトは、その注入を示して拒否されます。注入はアノテーションを追加するものであり、アノテーションを削除したりオプトアウトしたりすることはありません。 |
追加のプロパティは許可されません。
AnnotationSource
プラグインに渡される 1 つの定義ファイルです。ベース名のパスとファイルの内容を含みます。どちらもそのまま渡され、ホストは内容を解析しません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
path | string | はい | ソースファイルのベース名です。ホストはベース名のみを提供し、ホストの絶対パスは決して提供しないため、ワイヤーは移植可能かつ決定的です。 |
content | string | はい | ソースファイルの内容で、不透明な文字列としてそのまま渡されます。 |
追加のプロパティは許可されません。