コンテンツにスキップ
AggregaAggrega
言語の選択: 日本語
このページは機械翻訳されています。英語の原文を読む。

Aggrega Wasm ポリシーソケットのスキーマ

自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。

スキーマ ID: https://aggrega.ai/schemas/wasm-policy-v1beta1.schema.json

判定ロールにアタッチされたガバナンスプラグインが受け取るワイヤー形式(ir-verdict ロールでは PolicyInput、render-verdict ロールでは RenderPolicyInput)と出力するワイヤー形式(PolicyOutput)です。halt 重大度の判定はビルド時の診断とともにビルドを停止し、warn または info の判定は報告され、ビルドは続行します。IR ステージの入力グラフは、ケイパビリティに依存しない完全な IR グラフであり、ここで再宣言するのではなく ir-v1beta1.schema.json から参照されます。そのため、ポリシープラグインはコンパイラと同じノード、エッジ、アタッチメントの詳細を参照できます。プラグイン作成者は IR スキーマのバージョンに追従します。レンダーステージの入力は、グラフの代わりにレンダリングされた出力ファイルを含みます。Go、Rust、TypeScript のペイロード型はこのスキーマからプラグイン ABI パッケージに生成されるため、3 つの言語は 1 つのワイヤーを読み書きします。ゲストはそれらをこれらのパッケージから、またはプラグインキットが再エクスポートしている場合はプラグインキットを通じてインポートします。

次のいずれかの形

  • PolicyInput
  • RenderPolicyInput
  • PolicyOutput

定義

PolicyInput

静的解析がポリシーソケットに渡すペイロードです。完全な IR グラフ(Topology Builder が出力するものと同じ形)に加え、アナライザーが併せて列挙した事前計算済みのルーティングパスを含みます。

プロパティ種類必須説明
graphIRGraphはいケイパビリティに依存しない完全な IR グラフで、ir-v1beta1.schema.json を唯一の定義元とします。ポリシープラグインは、限定された射影ではなく、ノード/エッジ/アタッチメントの詳細全体に基づいて判断します。
precalculated_pathsPrecalculatedPath[]はいアナライザーが事前に列挙したルーティングパスです。ポリシーはグラフを再走査せずに到達可能性を判断できます。
sourcesPolicySource[]いいえホストがコンパイル時に読み込み、そのままプラグインに渡す定義ファイルで、パス順にソートされた順序付きリストです。ホストはバイト列を不透明な内容として読み込み、解析しません。アタッチメントがソースを宣言していない場合は存在しません。
settingsobjectいいえホストがそのままプラグインに渡す自由形式の設定オブジェクトです。ホストはその内容を解析せず、内容に基づいて動作もしません。アタッチメントが設定を宣言していない場合は存在しません。

追加のプロパティは許可されません。

PolicyOutput

ポリシープラグインが出力するレスポンスの形です。評価中に発火した判定を、発火した判定ごとに 1 つの診断として含みます。許可するルールは何も出力しないため、results 配列が空であれば判定は発火していません。

プロパティ種類必須説明
resultsDiagnostic[]はい発火した判定で、それぞれ 1 つの診断として、プラグインが出力した順に並びます。判定が発火しなかった場合は空です。
errorstringいいえゲストは実行されたものの操作を完了できなかった場合に設定される失敗メッセージです。成功時には存在しません。出力に含まれる診断とは別のものです。診断は結果を生成した実行中に見つかった問題を報告し、error は操作自体が完了しなかったことを報告します。ホストは error が存在する場合、プラグイン呼び出しの失敗として扱います。

追加のプロパティは許可されません。

RenderPolicyInput

render-verdict ロールにアタッチされたガバナンスプラグインが受け取るペイロードです。IR グラフの代わりに、ポリシーが判断の対象とするレンダリング済みの出力ファイルを含みます。

プロパティ種類必須説明
artifactsRenderedArtifact[]はいポリシーが判断の対象とするレンダリング済みの出力ファイルで、パス順にソートされた順序付きリストです。そのため、同一の入力に対する実行間でワイヤーはバイト単位で同一になります。
sourcesPolicySource[]いいえホストがコンパイル時に読み込み、そのままプラグインに渡す定義ファイルで、パス順にソートされた順序付きリストです。ホストはバイト列を不透明な内容として読み込み、解析しません。アタッチメントがソースを宣言していない場合は存在しません。
settingsobjectいいえホストがそのままプラグインに渡す自由形式の設定オブジェクトです。ホストはその内容を解析せず、内容に基づいて動作もしません。アタッチメントが設定を宣言していない場合は存在しません。

追加のプロパティは許可されません。

RenderedArtifact

1 つのレンダリング済み出力ファイルです。そのパスと、そのパスにレンダリングされた内容を含みます。

プロパティ種類必須説明
pathstringはいレンダリングされたファイルの出力パスで、レンダールートからの相対パスです。
contentstringはいこのパスにレンダリングされた内容です。
treeanyいいえこの成果物を解析した構造化ツリーで、ホストがプラグインに渡す前に内容を解析した場合に存在します。プラグインがネイティブに読み込まないソース形式の正規の JSON 表現です(たとえば、JSON に解析された HCL の成果物)。最上位はオブジェクト、配列、スカラーのいずれかで、解析されたドキュメント自体の形に一致します。ホストが成果物を解析しなかった場合は存在せず、その場合プラグインはネイティブの内容を直接読み込みます。ホストはツリーを不透明なまま受け渡し、内容を解釈せずにそのまま渡します。
formatstringいいえ成果物がレンダリングされた形式で、生成元の provider が宣言した場合に存在します。生成元の provider が形式を宣言しなかった場合は存在しません。

追加のプロパティは許可されません。

PolicySource

プラグインに渡される 1 つの定義ファイルです。ベース名のパスとファイルの内容を含みます。どちらもそのまま渡され、ホストは内容を解析しません。

プロパティ種類必須説明
pathstringはいソースファイルのベース名です。ホストはベース名のみを提供し、ホストの絶対パスは決して提供しないため、ワイヤーは移植可能かつ決定的です。
contentstringはいソースファイルの内容で、不透明な文字列としてそのまま渡されます。

追加のプロパティは許可されません。

PrecalculatedPath

アナライザーが具体化する、事前に列挙された 1 つのルーティングパスです。ポリシールールはグラフを再走査せずに到達可能性を判断できます。

プロパティ種類必須説明
path_idstringはいこのパスの安定した識別子です。同一の入力に対する実行間で決定的です。
nodesstring[]はいパスが通過するノード ID の順序付きシーケンスで、始点から終端までの順です。
attached_featuresstring[]はいパス上のいずれかのノードにアタッチされた Feature の型 URI の和集合で、アルファベット順にソートされます。集合のメンバーシップのセマンティクスに従い、複数のノードが同じ Feature を持っていても 1 回だけ現れます。パス上のどのノードも Feature のアタッチメントを持たない場合は空です。

追加のプロパティは許可されません。