Aggrega Wasm Mutator Socket スキーマ
自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。
スキーマ ID: https://aggrega.ai/schemas/wasm-mutator-v1beta1.schema.json
label-transform ロールにアタッチされたガバナンスプラグインが受け取るワイヤー形式(MutatorInput)と出力するワイヤー形式(MutatorOutput)です。このロールはトポロジー構築時、グラフが構築された後で判定される前に実行されます。プラグインは JSON Patch ドキュメントを返し、ホストはそれらをノードのラベルにのみ適用し、それ以外には適用しません。グラフの他の部分に及ぶパッチがあるとビルドを停止します。Go、Rust、TypeScript のペイロード型はこのスキーマからプラグイン ABI パッケージに生成されるため、3 つの言語は 1 つのワイヤーを読み書きします。ゲストはそれらをこれらのパッケージから、またはプラグインキットが再エクスポートしている場合はプラグインキットを通じてインポートします。
次のいずれかの形
MutatorInputMutatorOutput
定義
MutatorInput
ホストが呼び出しのたびにミューテータープラグインに渡すペイロードです。リリースレベルのコンパイルコンテキストと、各ノードのラベルとそのインスタンスが宣言する値を持つトポロジーグラフの射影で構成されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
compilation_context | CompilationContext | はい | コンプライアンス、FinOps、ガバナンスのどのルールをビルドに適用するかを判断する際に mutator が参照する、Release レベルのメタデータです。 |
graph | MutatorGraph | はい | ミューテータープラグインに公開されるトポロジーグラフの射影です。各ノードの Component、その解決済みバージョン、ラベル、そのインスタンスが宣言する値を含みます。完全なトポロジー結果よりも意図的に範囲を狭めています。ミューテーターの役割はラベル付けであり、トポロジーの再構成ではないため、エッジと feature のペイロードは公開されません。値は読み取るために含まれており、開発者が宣言した構成によってラベルを決められます。パッチはラベルにのみ及び、それ以外には及ばないため、プラグインは値を変更できません。 |
sources | MutatorSource[] | いいえ | ホストが読み取り、そのままプラグインに渡す定義ファイルで、パス順にソートされた順序付きリストです。ホストはバイト列を不透明な内容として読み取り、解析しません。アタッチメントがソースを宣言していない場合は存在しません。 |
settings | object | いいえ | ホストがそのままプラグインに渡す自由形式の設定オブジェクトです。ホストはその内容を解析せず、内容に基づいて動作もしません。アタッチメントが設定を宣言していない場合は存在しません。 |
追加のプロパティは許可されません。
MutatorOutput
ミューテータープラグインが出力するレスポンス形式です。ホストがトポロジーグラフに適用する、不透明な JSON Patch ドキュメントのリストです。パッチはスキーマ層では不透明なままであるため、ホストはゲストがすでに実装している JSON Patch パーサーを重複して実装する必要がありません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
patches | any[] | はい | トポロジーグラフに順番に適用する、不透明な JSON Patch ドキュメントです。 |
error | string | いいえ | ゲストが実行されたものの操作を完了できなかったときに設定される失敗メッセージです。成功時には存在しません。ホストは、存在する error を失敗したプラグイン呼び出しとして示します。 |
追加のプロパティは許可されません。
CompilationContext
コンプライアンス、FinOps、ガバナンスのどのルールをビルドに適用するかを判断する際に mutator が参照する、Release レベルのメタデータです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
release_name | string | はい | Release の metadata.name です。 |
environment | string | はい | Release が実行される環境ラベルです(例: dev、staging、prod)。 |
追加のプロパティは許可されません。
MutatorGraph
ミューテータープラグインに公開されるトポロジーグラフの射影です。各ノードの Component、その解決済みバージョン、ラベル、そのインスタンスが宣言する値を含みます。完全なトポロジー結果よりも意図的に範囲を狭めています。ミューテーターの役割はラベル付けであり、トポロジーの再構成ではないため、エッジと feature のペイロードは公開されません。値は読み取るために含まれており、開発者が宣言した構成によってラベルを決められます。パッチはラベルにのみ及び、それ以外には及ばないため、プラグインは値を変更できません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
nodes | MutatorNode のマップ | はい | 絶対ノード ID をキーとするノードです。 |
追加のプロパティは許可されません。
MutatorNode
ミューテータープラグインがルールを評価する対象となる、ノードごとの射影です。ノードが実装する Component、解決されたその Component のバージョン、ノードが持つラベル、そのインスタンスが宣言する値を含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
component | string | はい | ノードがインスタンス化する基盤の Component の名前です。 |
resolved_version | string | はい | リゾルバーがこのノードに固定した Component の正確なセマンティックバージョンです。 |
labels | string のマップ | はい | ノードのダックタイピングおよびオントロジーのラベルです。 |
values | object | いいえ | ノードのコンポーネントインスタンスが Aggregate で宣言する値で、作成者が記述したとおりのキーで、作成者の順に並びます。Aggregate 内のすべてのテンプレートはすでにそのパラメーターに対して評価されているため、パラメーターに引き上げられた値は、Release が提供した値、またはパラメーターのデフォルトとして届きます。ここにあるのはインスタンス自身の値のみです。Component のスキーマが宣言するデフォルトや、Recipe または Feature が提供するものは含まれません。Component が機密と宣言する値は、グラフ全体に対するガバナンス判定が受け取るのとまったく同じように、伏せられた状態で届きます。その位置には、その判定が持つものと同じ単一キーの伏せ字マーカーオブジェクトが置かれ、宣言された理由が示されます。どの宣言も及ばない兄弟の値は記述どおりに届きます。プラグインはこれらを読んで追加するラベルを決めます。パッチはこれらに及びません。インスタンスが値を宣言しない場合は存在しません。 |
追加のプロパティは許可されません。
MutatorSource
プラグインに渡される 1 つの定義ファイルです。ベース名のパスとファイルの内容を含みます。どちらもそのまま渡され、ホストは内容を解析しません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
path | string | はい | ソースファイルのベース名です。ホストはベース名のみを提供し、ホストの絶対パスは決して提供しないため、ワイヤーは移植可能かつ決定的です。 |
content | string | はい | ソースファイルの内容で、不透明な文字列としてそのまま渡されます。 |
追加のプロパティは許可されません。