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

Aggrega Wasm FeatureRecipe パイプラインステップソケットのスキーマ

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

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

フィーチャーレシピパイプラインのステッププラグインソケットが受け取るワイヤー形式(FRPStepInput)と出力するワイヤー形式(FRPStepOutput)です。FRP ステップは、Recipe または FeatureRecipe で宣言されたインラインのパイプラインエントリーごとに実行されます。ホストはキー付きドキュメントセットを丸ごとステップに渡し、ステップは対象とするドキュメントを内容によって選択し、キーで指定する RFC 6902 パッチに加えて副作用と診断を返します。これは、トポロジーグラフ全体に対して一度だけ実行され不透明なラベルパッチを返す label-transform ロールとは別のゲスト契約です。Go、Rust、TypeScript のペイロード型はこのスキーマからプラグイン ABI パッケージに生成されるため、3 つの言語は 1 つのワイヤーを読み書きします。ゲストはそれらをこれらのパッケージから、またはプラグインキットが再エクスポートしている場合はプラグインキットを通じてインポートします。

次のいずれかの形

  • FRPStepInput
  • FRPStepOutput

定義

FRPStepInput

feature-recipe-pipeline のゲストが 1 つのパイプラインステップについて受け取るペイロードです。ホストが丸ごと渡すキー付きドキュメントセット、Recipe がこのステップ用に宣言したステップローカルな入力、レンダリング時のコンテキスト、パイプライン内でのステップの位置、およびすでに実行されたステップの記録で構成されます。

プロパティ種類必須説明
documentsDocumentSetはいパイプラインのゲストが入力面として受け取る、キー付きでスコープをルートとするアドレス指定可能なユニットのセットです。ホストはセット全体を渡し、その内容を解釈しません。ゲストは対象とするドキュメントを内容によって選択し、パッチをキーによってアドレス指定します。
step_inputobjectいいえステップのレンダリング済み with ブロックで、ゲストがステップローカルな入力として読み取る、作成者が順序を決めたキーセットです。作成者の順序を保持するため、同一の入力に対する実行間でペイロードはバイト単位で同一になります。
contextobjectはいホストがステップに渡すレンダー時のコンテキストで、その JSON ドキュメントのバイト列として運ばれます。このスキーマはこのオブジェクトを宣言せず、ホストはそこから何も読み戻しません。Recipe またはコンポーネントスコープの FeatureRecipe のステップは、次を受け取ります。parameters(名前順に並べた Release のパラメーター値で、ない場合は存在しません)、annotations(ノードのアノテーションを、それぞれが記述された場所によって aggregate、release、catalog に分けたもので、空の場合はそれぞれ存在しません)、そして boundary(ノードが属する境界で、name、path(そのセグメント)、sync_wave(0 の場合は存在しません)、directory、sub_directory(ない場合は存在しません)、annotations(Release の境界がノードまでカスケードする集合で、自身の Release エントリーのものが最後に重ねられます。空の場合は存在しません))です。ホストコンポーネントを持たない境界スコープの FeatureRecipe のステップは、parameters、境界自身のアノテーション集合である release バケットのみを持つ annotations、そして name、path を持ち、その同じ集合を annotations とする boundary を受け取ります。同じ FeatureRecipe の provider レンダーは同じコンテキストを受け取ります。インデント幅 yaml_indent はステップには設定されません。
step_indexintegerはいパイプライン内でのこのステップの 0 始まりの位置です。
preceding_stepsPrecedingStep[]いいえこのステップより前に実行されたパイプラインステップです。ゲストはこれにより、前に何が行われたかを調べられます。

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

FRPStepOutput

feature-recipe-pipeline のゲストが 1 つのパイプラインステップについて返すペイロードです。ホストがキー付きドキュメントセットに適用する RFC 6902 パッチ、このステップが生じさせた副作用、およびゲストが発行した診断で構成されます。

プロパティ種類必須説明
patchesJSONPatchOp[]いいえステップがキー付きセット内のドキュメントに対して発行する、構造化された RFC 6902 操作です。各操作は対象ドキュメントをスコープとキーで指定し、続いて op、path、value を明示的に指定します。label-transform ロールの不透明なパッチリストとは異なります。FRP ステップのパッチはホストによって適用され、ステップが失敗した場合はスナップショットによって復元されるため、ここでは操作は不透明ではなく明示的です。
side_effectsSideEffect[]いいえ既存ドキュメントへのパッチ以外にこのステップが生じさせた効果です(たとえば CRD の出力やファイルの書き込み)。
diagnosticsDiagnostic[]いいえゲストが発行した診断です。各要素は Wasm プラグイン共通の診断の形です。
outputsobjectいいえゲストがこのステップについて返すアドレス指定可能な出力で、後続のステップやテンプレートが読み取れるようにステップの出力を設定する、作成者が順序を決めたキーセットです。作成者の順序を保持するため、同一の入力に対する実行間でペイロードはバイト単位で同一になります。ステップが出力を返さない場合は存在しません。
errorstringいいえゲストは実行されたものの操作を完了できなかった場合に設定される失敗メッセージです。成功時には存在しません。出力に含まれる診断とは別のものです。診断は結果を生成した実行中に見つかった問題を報告し、error は操作自体が完了しなかったことを報告します。ホストは error が存在する場合、プラグイン呼び出しの失敗として扱います。

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

DocumentSet

パイプラインのゲストが入力面として受け取る、キー付きでスコープをルートとするアドレス指定可能なユニットのセットです。ホストはセット全体を渡し、その内容を解釈しません。ゲストは対象とするドキュメントを内容によって選択し、パッチをキーによってアドレス指定します。

プロパティ種類必須説明
ownUnit のマップはいノード自身のレンダリング済み出力で、ユニットトークンをキーとします。キーの順序を保持するため、セットは安定した順序でワイヤーに渡り、同一の入力に対する実行間でペイロードはバイト単位で同一になります。
hostUnit のマップいいえcomponent スコープの FeatureRecipe がアタッチされているコンポーネントのレンダリング済み出力で、エンティティ間をまたぐ面です。ホストコンポーネントを持たない Recipe ステップおよび boundary スコープの FeatureRecipe ステップでは存在しません。キーの順序を保持するため、セットは安定した順序でワイヤーに渡り、同一の入力に対する実行間でペイロードはバイト単位で同一になります。

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

Unit

プロバイダーが出力したものが分割される、アドレス指定可能な 1 つの断片で、出力の 1 断片に対するハイブリッドなビューです。構造化ユニットはツリー(RFC 6902 でアドレス指定可能なビュー)を持ち、PATCH の対象になります。不透明ユニットはメディアタイプとバイトのみを持ち(ツリーはありません)、SELECT と EMIT の対象にはなりますが PATCH の対象にはなりません。

プロパティ種類必須説明
tokenstringはいコーデックが割り当てる不透明な位置アドレスです。単一ドキュメントのファイルでは出力されたファイル名、1 つのファイルが複数のドキュメントを持つ場合は <filename>#<ordinal>(ファイル内の順序)です。ゲストはこれを不透明なものとして扱います。ユニットを内容によって選択してトークンをそのまま返し、解析はしません。
bytesstringいいえユニットの元のバイトで、再構成の元になります。再構成は構造上バイト単位で忠実です。変更されていないバイトはここからそのまま再結合されます。各キットはこれを独自のフィールド型で保持します。その型がバイト型であれば生のまま、文字列型であればステップが復元のためにデコードする base64 エンコード形式です。生成されたエンコーダーが、フィールドとワイヤーがバイトを運ぶ形式との間で変換します。
media_typestringいいえユニットのコンテンツタイプ(たとえば標準の YAML コーデックでは application/yaml)で、ゲストは何を扱っているかを知ることができます。
treeanyいいえコーデックが生成した場合の、ユニットの RFC 6902 でアドレス指定可能な正規化ビューです。生成しなかった場合は存在しません。ツリーを持つユニットは構造化ユニット(PATCH の対象)であり、ツリーを持たないユニットは不透明です。ドキュメントはホストにとって不透明であり、ホストはバイトを解釈せずにそのまま渡すため、このスキーマ層ではツリーは任意の JSON 値を持ちます。

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

JSONPatchOp

FRP ステップがキー付きセット内の 1 つのドキュメントに対して発行する、1 つの RFC 6902 JSON-Patch 操作です。scope と key が対象ドキュメントを指定し、op、path、value、from がそのドキュメント内の位置に対する操作を表します。

プロパティ種類必須説明
scopestring (enum)はい操作の対象となるドキュメントルートです。own(ノード自身のレンダリング済みドキュメント)または host(component スコープの FeatureRecipe がアタッチされているコンポーネントのドキュメント)です。許可される値:"own"、"host"
keystringはい指定されたルート内の、出力ファイル名のキーです。ゲストが内容によって選択したドキュメントから実行時に知ったキーです。
opstringはいRFC 6902 の操作で、add、remove、replace、move、copy、test のいずれかです。
pathstringはい指定されたドキュメント内の対象位置を指す RFC 6901 JSON Pointer です。
valueanyいいえadd、replace、test のオペランドで、それ以外では省略されます。ゲストが作成した任意の JSON ドキュメント断片で、ホストは不透明なまま渡します。このスキーマ層では任意の JSON 値を持ちます。
fromstringいいえmove と copy の元を指すポインターで、それ以外では省略されます。

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

SideEffect

feature-recipe-pipeline のステップが既存ドキュメントへのパッチ以外に生じさせる 1 つの効果です。kind は emit_crd または emit_file です。スキーマはこれを開いた文字列のままにしているため、ABI を壊さずに新しい種類を追加できます。それ以外の種類ではビルドが停止します。kind が emit_crd の場合は crd が CRD ドキュメントを持ち、file は省略されます。kind が emit_file の場合は file が書き込むファイルを持ち、crd は省略されます。

プロパティ種類必須説明
kindstringはい効果の種類で、emit_crd または emit_file です。スキーマはこのフィールドを開いた文字列のままにしているため、ABI を壊さずに新しい種類を追加できます。それ以外の種類ではビルドが停止し、ノード、副作用、その種類が示されます。
scopestring (enum)いいえ出力が追加されるドキュメントルートです。own(ノード自身のセット)または host(アタッチ先のホストコンポーネントのセット)です。scope が存在しない場合、適用時には own を意味します。許可される値:"own"、"host"
crdanyいいえkind が emit_crd の場合にステップが出力する CRD ドキュメントです。ホストにとって不透明であり、ホストはこれを解釈せずにそのまま渡します。このスキーマ層では任意の JSON 値を持ちます。
fileSideEffectFileいいえemit_file の副作用が書き込むファイルで、対象パスとファイルの内容です。

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

SideEffectFile

emit_file の副作用が書き込むファイルで、対象パスとファイルの内容です。

プロパティ種類必須説明
pathstringはいファイルの書き込み先となる対象パスです。
contentstringはい書き込むファイルの内容です。

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

PrecedingStep

現在のステップより前に実行された 1 つのパイプラインステップです。ゲストはこれにより、前に何があったかを確認できます。ステップのパイプラインインデックス、そのステップが指定したプラグイン、そのステップが出力した副作用を含みます。

プロパティ種類必須説明
indexintegerはいパイプライン内での先行ステップの 0 始まりの位置です。
plugin_uristringはい前のパイプラインエントリーが plugin フィールドで記述どおりに指定したプラグインです。
side_effectsSideEffect[]いいえ先行ステップが出力した副作用です。

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