Aggrega Wasm Describe Socket スキーマ
自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。
スキーマ ID: https://aggrega.ai/schemas/wasm-describe-v1beta1.schema.json
すべての Wasm プラグインが describe() エクスポートから返すワイヤ形式です(PluginDescriptor)。describe() はプラグインの自己宣言であり、ホストがプラグインを読み込む際に一度だけ読み取ります。その内容は、ゲストがバインドする ABI バージョン、プラグインの種類、提供するエクスポートとそれぞれのエクスポートの機能宣言、プラグイン単位の機能の自己申告、任意のプロバイダのレンダリング動作の契約、任意のインポーターの認識契約、任意の CLI コマンド、任意の設定スキーマ、および任意の作成者メタデータです。1 つの形で、プロバイダ、リンター、feature-recipe パイプラインのステップ、ガバナンス、CLI、パーサー、インポーターのすべてのプラグインの種類を扱います。ホストは他のエクスポートをディスパッチする前に describe() を読み取り、受け入れられないディスクリプタは、ディスパッチ時にプラグインを誤って呼び出すのではなく、拒否します。
次のいずれかの形
PluginDescriptor
定義
PluginDescriptor
プラグインの完全な自己宣言で、describe() から返され、ロード時に一度読み取られます。ABI 互換性のハンドシェイク、プラグインの種類、提供するエクスポート、および種類ごとの任意のサーフェス (プロバイダーのレンダー動作コントラクト、インポーターの認識コントラクト、CLI プラグインのコマンド、設定スキーマ、作成者メタデータ) を含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
abi_version | const “v1beta1” | はい | ゲストがバインドするプラグイン ABI です。ホストはこのバージョンのみを受け入れます。他の ABI に対してビルドされたゲストは、ディスパッチ時に誤って呼び出されるのではなく、ロード時に拒否されます。定数: "v1beta1" |
plugin_type | string (enum) | はい | プラグインの種類です。ホストが検証する最小エクスポート規則と、エクスポート名と組み合わせて既定の入力配信パターンを選択します。governance プラグインはビルドパイプラインの変換および判定の役割を担います。何を出力できるかを決めるのは、その種類ではなく、アタッチされる役割です。許可される値: "provider"、"linter"、"pipeline-step"、"governance"、"cli"、"parser"、"importer" |
capabilities | string[] | いいえ | プラグインが提供するものです。ワイヤ上ではフラットなリストで、隣接する必須の plugin_type が、各エントリが 4 つの意味のどれを持つかを決めます。プロバイダーの場合は、出力の形をレンダーするケイパビリティ名 (helm や compose など)。feature-recipe-pipeline ステップの場合は、そのステップが互換性を持つプロバイダーのケイパビリティ。パーサーの場合は、正規の構造化ツリーに変換するソース形式で、それぞれ parse: |
exports | PluginExport[] | はい | プラグインが提供するエクスポートで、宣言順です。ホストは種類ごとの最小エクスポートが存在することを検証し、各エクスポートを呼び出す前にエクスポートごとのホストサーフェスをバインドします。 |
contract | ProviderContract | いいえ | プロバイダーのレンダー動作の自己報告です。レンダーする入力の種類、ディスパッチグループのノードごとの出力をどのように組み立てるか、および適用するアーティファクトテンプレートの区切り文字のペアを示します。個々のエクスポートではなく、プロバイダー全体を記述します。レンダー動作コントラクトを宣言しないプラグインでは存在しません。 |
importer | ImporterContract | いいえ | インポートが形式を指定しない場合に、インポーターが公開する形式のソースがどのように認識されるかについての、インポーターの自己報告です。plugin_type が importer のプラグインのみが宣言できます。他のプラグインが宣言すると、ロード時に拒否されます。形式を認識する方法を宣言しないインポーターでは存在せず、その形式は名前で指定した場合にのみ使われます。 |
description | string | いいえ | プラグイン自身による、その機能についての 1 行の人間が読める説明で、エクスポートごとの説明やエンティティのメタデータの説明とは別のものです。情報提供のみを目的とし、ホストはこれを検証も使用もしません。 |
commands | PluginCLICommand[] | いいえ | CLI プラグインが追加するトップレベルの aggrega コマンド動詞で、それぞれ独自の短いヘルプ行を持ちます。1 つの CLI プラグインが複数のコマンドを追加できます。ホストはエントリごとに 1 つのコマンドを登録し、呼び出し時に解決されたコマンド名をゲストに渡します。CLI 以外のプラグインは空のままにします。 |
settings_schema | object | いいえ | アタッチメントが持つ、オペレーターが指定する設定に型を付けるためにプラグインが宣言する任意の JSON Schema ドキュメントです。存在する場合、ホストはロード時にこれをコンパイルし、プラグインを呼び出す前のディスパッチ時にアタッチメントの設定をこれに対して検証します。適合しない設定はビルドを停止させます。存在しない場合、プラグインは形を宣言せず、設定はそのまま渡されます。スキーマはプラグイン自身の自由形式の宣言であり、ホストはこれに対して汎用的な JSON Schema 検証を実行し、設定の意味は解釈しません。 |
metadata | PluginDescriptorMeta | いいえ | 任意の作成者およびビルド来歴の情報です。動作のコントラクトは持たず、ホストはこれを検証も使用もしません。 |
追加のプロパティは許可されません。
PluginExport
describe() で宣言される、プラグインが提供する 1 つのエクスポートです。ホストは名前でエクスポートにディスパッチし、エクスポートが宣言したホスト関数が必要とする最小権限のホストサーフェスをバインドします。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | エクスポートの ABI 名です。例: render_node、assemble_boundary、lint_rules、step。ホストはこの名前でエクスポートにディスパッチします。 |
input_pattern | string (enum) | いいえ | ホストがエクスポートの入力をどのように配信するかを示します。b はペイロード全体をインラインで配信し、ゲストはペイロードのみからレンダーします。a は小さなペイロードを配信し、ゲストはホスト関数を通じてそれを補完します。このフィールドを省略したエクスポートは、プラグインの種類と名前に応じた既定値を取ります。許可される値: "a"、"b" |
host_functions | string[] | いいえ | このエクスポートがインポートするホスト関数名です。すべての名前はホスト関数の許可リストに含まれている必要があります。この宣言が正となり、ロード時にゲストがモジュールから実際にインポートする関数と照合されるため、ゲストが実際に呼び出す関数と食い違うことはありません。 |
description | string | いいえ | エクスポートを説明する任意の人間が読めるテキストです。カタログの読み手向けのドキュメントであり、ホストはこれを検証も使用もしません。 |
stability | string (enum) | いいえ | エクスポートの安定性レベルです。省略された値は安定性の主張を持ちません。許可される値: "stable"、"experimental"、"deprecated" |
operates | string (enum) | いいえ | このエクスポートが実行するパイプライン操作です。patch は既存のレンダー済みドキュメントを変更し、emit は新しいドキュメントを追加します。値はロード時に形がチェックされ、ランタイムはステップをディスパッチする際にこれを読み取ります。許可される値: "patch"、"emit" |
scope | string (enum) | いいえ | このエクスポートが操作するドキュメントのルートです。own はノード自身のレンダー済みドキュメント、host はコンポーネントスコープの feature recipe がアタッチされているコンポーネントのドキュメントです。値はロード時に形がチェックされ、ランタイムはディスパッチ時にスコープのドキュメントを解決します。許可される値: "own"、"host" |
selector | string | いいえ | エクスポートが何に作用するかについての、自由形式の人間が読める説明です。カタログの読み手向けのドキュメントであり、ホストはその内容を検証も使用もしません。 |
input | object | いいえ | パイプラインエントリが with ブロックを通じて指定するステップローカルの入力に型を付けるために、ステップエクスポートが宣言する任意の JSON Schema ドキュメントです。存在する場合、ステップの with 入力が満たす形を記述します。存在しない場合、エクスポートは入力コントラクトを宣言しません。スキーマは、パイプラインの作成者がこのエクスポートに対して対象とする入力サーフェスについての、エクスポート自身の自由形式の宣言です。 |
output | object | いいえ | 1 つのステップで返す出力に型を付けるために、ステップエクスポートが宣言する任意の JSON Schema ドキュメントです。これは、後続のステップやテンプレートが読み取るためにステップが提供する、アドレス指定可能な出力の形です。存在する場合、返される出力の形を記述します。存在しない場合、エクスポートは出力コントラクトを宣言しません。スキーマは、このエクスポートが生成する出力サーフェスについての、エクスポート自身の自由形式の宣言です。 |
追加のプロパティは許可されません。
PluginCLICommand
describe() で宣言される、CLI プラグインが追加する 1 つのトップレベルの aggrega コマンド動詞です。ホストはエントリごとに 1 つのコマンドを登録し、呼び出し時に解決されたコマンド名をゲストに返すため、1 つのゲストが複数のコマンドを担い、名前に応じて動作を選択できます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | ホストが登録するコマンド動詞です。オペレーターが呼び出す aggrega トークンであり、どのコマンドが呼ばれたかに応じてゲストが処理を振り分けられるよう、ホストがゲストに渡す識別子です。宣言されるすべてのコマンドはこれを指定する必要があります。 |
description | string | いいえ | コマンドの 1 行の短いヘルプテキストで、コマンド一覧とヘルプ出力に表示されます。任意のドキュメントであり、ホストはこれを検証も使用もしません。 |
flags | PluginCommandFlag[] | いいえ | コマンドのフラグで、宣言順です。各エントリは、ホストがコマンドに登録する 1 つのフラグを追加し、aggrega help |
追加のプロパティは許可されません。
PluginCommandFlag
CLI プラグインがコマンドに宣言する 1 つのフラグで、describe() で報告されます。ホストはこれをコマンドに登録し、aggrega help
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | フラグの長い名前です。オペレーターがコマンドラインで渡す —name トークンです。宣言されるすべてのフラグはこれを指定する必要があります。1 文字以上である必要があります。 |
shorthand | string | いいえ | フラグの任意の 1 文字の短いエイリアスです。オペレーターが長い名前の代わりに渡せる -x 形式です。存在しない場合、フラグに短いエイリアスはありません。 |
description | string | いいえ | フラグの 1 行のヘルプテキストで、コマンドのヘルプ出力に表示されます。任意のドキュメントであり、ホストはこれを検証も使用もしません。 |
type | string | いいえ | フラグの値の型です。たとえば string、bool、int などです。存在しない場合、型についての主張はありません。 |
default | string | いいえ | オペレーターがフラグを渡さない場合のデフォルト値で、文字列として表されます。存在しない場合、フラグはデフォルトを宣言しません。 |
追加のプロパティは許可されません。
PluginDescriptorMeta
プラグインが describe() で宣言する、任意の作成者情報とビルド来歴のメタデータです。情報提供のみを目的とし、ホストはこれを検証も使用もしません。version と commit のフィールドは、ビルド時にゲストに刻印されるビルド来歴です。刻印されていないビルドではこれらは省略されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
author | string | いいえ | プラグインの作成者です。 |
repository | string | いいえ | プラグインのソースリポジトリです。 |
license | string | いいえ | プラグインのライセンス識別子です。 |
version | string | いいえ | ビルド時にゲストに刻印されるビルド来歴のバージョンです。刻印されていないビルドでは省略されます。 |
commit | string | いいえ | ゲストのビルド元となったビルド来歴の短いコミットです。刻印されていないビルドでは省略されます。 |
追加のプロパティは許可されません。
ProviderContract
プロバイダーが、レンダリングするノード全体にわたって実行するコンパイル時のレンダリング動作の自己宣言です。受け付ける入力の種類、ディスパッチグループのノードごとの出力を単一のアーティファクトに組み立てるかどうかとその方法、インポートされたアーティファクトファイルに適用する Go テンプレートの区切り文字ペア、Recipe がそのバウンダリの共有出力に提供するファイルを受け付けるかどうか、そしてそのエコシステムがソースと一緒に決して配布しないファイルを記述します。特定のエクスポートではなく、プロバイダー全体を記述します。ロードゲートはこれをエンティティに記述された主張と照合します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
input_kinds | InputKinds | はい | プラグインがレンダリングする 3 つの Recipe 入力種類のうちどれか: ソースとなるファイルセット、合成されたワークロード、アーティファクトのみのスタンドアロンノードです。 |
boundary_assembly | string (enum) | はい | プラグインがディスパッチグループのノードごとのレンダリング出力をどのように結合するか: none は各ノードの出力をディスパッチパスに直接書き込み、merge はノードごとのフラグメントを 1 つのドキュメントに統合し、nest は各ノードの出力を包括構造内のそれぞれの位置に配置します。空の値は組み立てについての主張を持ちません。許可される値: "none"、"merge"、"nest"、"" |
artifact_delimiters | ArtifactDelimiters | いいえ | プラグインがインポートされたアーティファクトファイルに適用する Go テンプレートの区切り文字ペアです。存在しない場合はデフォルトの開始・終了ペアを意味します。ターゲット構文がそのペアと衝突するプラグインは、ここで代替のペアを報告します。 |
assembly_name_annotation | AssemblyNameAnnotation | いいえ | 解決された値が、プラグインがディスパッチグループから組み立てるアーティファクトの名前となるバウンダリアノテーションです。存在しない場合、プラグインはディスパッチパスのみから組み立て結果の名前を決めます。 |
reusable_instance | 真偽値 | いいえ | ロードされた 1 つのプラグインインスタンスが、境界の通過ごとに新しいインスタンスを使う代わりに、ビルドのすべてのレンダリング、組み立て、検証の通過を処理できるかどうかです。プラグインは、通過をまたいで状態を保持しない場合にのみ true を宣言します。存在しない場合 (false) が安全なデフォルトで、ホストは通過ごとに新しいインスタンスをロードします。 |
cross_boundary_linking | 真偽値 | いいえ | プラグインが、link_publish と link_resolve エクスポートを通じてプロバイダー固有の相互参照の配線を生成することで、バウンダリをまたぐ uses エッジ (消費側と被消費側の端が異なるディスパッチグループに組み立てられるエッジ) を配線するかどうかです。プラグインは両方をエクスポートする場合にのみ true を宣言します。存在しない場合 (false) が安全なデフォルトで、プラグインはバウンダリをまたぐエッジを配線しません。 |
omits | 真偽値 | いいえ | プラグインが render_node 入力に含まれる omit エントリに従うかどうかです。つまり、エントリに一致するすべてのレンダリング単位を返すものすべてから除外し、渡されたエントリごとに 1 つのカウントを出力の omitted で報告します。プラグインは両方を行う場合にのみ true を宣言します。存在しない場合 (false) が安全なデフォルトで、プラグインは何かを除外するという主張をしません。 |
boundary_artifacts | 真偽値 | いいえ | プラグインのターゲットが、レンダリング先のバウンダリの共有出力に Recipe が提供するファイルを受け付けるかどうかです。ホストはそれらのファイルを評価し、ディスパッチグループの組み立て済み出力を保持するディレクトリに、プラグインの組み立てが書き込むものと並べて、それぞれを 1 回書き込みます。プラグインにはそれらのファイルは一切渡されず、読み取ることもありません。したがってこの主張は、そのターゲットがそこに置かれたファイルをバウンダリの出力の一部として扱うという表明です。存在しない場合 (false) が安全なデフォルトで、このプラグインに対してそのようなファイルを宣言する Recipe は、何かがレンダリングされる前に拒否されます。 |
nest_segment | string | いいえ | ディスパッチグループのノードごとの出力をネストするプラグインで、プラグインのターゲットが各コントリビューター自身のサブディレクトリを配置する親ディレクトリです。ホストはこのセグメント、コントリビューターのオーサリングレベルの名前、各ファイル自身のパスを連結します。boundary_assembly が nest の場合にのみ読み取られます。存在しない場合、ホストは各コントリビューターのサブディレクトリを、囲むディレクトリなしでディスパッチ位置に直接配置します。値は 1 つのディレクトリを指定するもので、パスを指定することはありません。パス区切り文字を含む値や、カレントディレクトリまたは親ディレクトリを指定する値は拒否されます。ホストがコントリビューターの名前をこれに合成するため、パスの断片があるとコントリビューターのファイルがディスパッチ位置の下以外の場所に配置されてしまうからです。 |
source_ignore | SourceIgnore | いいえ | このプラグインのエコシステムが、レンダリングするソースと一緒に決して配布しないファイルで、無視ルールとして宣言されます。ホストは、作成者がこのプラグインが担当するケイパビリティを持つ Recipe または FeatureRecipe をピン留めするときにこの宣言を読み取ります。これらのルールを作成者自身の無視ファイルと組み合わせ、組み合わせたルールをエンティティと並ぶエンティティロックに記録し、以降はエンティティのすべての公開、ローカルソースのすべての比較、すべてのレンダリングで、プラグインに再度問い合わせるのではなく記録されたルールを適用します。そのため、あるケイパビリティ向けに公開された Recipe は、公開者のルールが残したファイルを含み、プラグインは同じ ABI バージョンを話し、その契約がエンティティの主張と一致し、そのセット外のファイルを必要としない場合にそれをレンダリングします。セットから除外されたファイルを必要とするプラグインは、ビルドを明示的に失敗させ、そのファイルを示さなければなりません。ホストの役割は、セットに含まれないファイルのパックや読み取りを、そのファイルを示して拒否することです。存在しない場合は無視ルールを宣言せず、プラグインがレンダリングするソースは作成者自身のルールが残すすべてのファイルを保持します。 |
追加のプロパティは許可されません。
SourceIgnore
プラグインのエコシステムがソースディレクトリに適用する gitignore 構文の無視ルールです。スラッシュを含まない、または末尾にのみ含むパターンは任意の深さの名前に一致し、それ以外のスラッシュを含むパターンは対象となるディレクトリのルートから読み取られ、末尾のスラッシュはディレクトリにのみ一致し、先頭の ! は以前のルールが除外したものを戻します。ルールは順に適用され、後の一致が前の一致を上書きします。ルールが除外したディレクトリには入らないため、そのディレクトリ自体が先に戻されない限り、その下のものは戻りません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
patterns | string[] | いいえ | エコシステム自身の無視パターンで、それぞれ走査対象のローカルソースディレクトリのルートを範囲とし、適用される順に並びます。存在しないか空の場合は何も宣言しません。 |
files | string[] | いいえ | エコシステムがソース内で従う無視ファイルの名前です。たとえばチャートの場合は .helmignore です。ソースの走査でこれらの名前のいずれかのファイルが見つかると、その行は同じ構文の追加パターンとして読み取られ、それぞれそのファイルを含むディレクトリを範囲とし、上記のパターンの後に適用されます。空行と # で始まる行はスキップされます。そのような名前のファイル自体は、ルールが除外しない限り含まれます。存在しないか空の場合は何も指定しません。 |
追加のプロパティは許可されません。
InputKinds
プラグインがレンダリングする Recipe の入力の種類です。各フィールドは独立した宣言であり、プラグインは任意の組み合わせを報告できます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
sourced | 真偽値 | はい | プラグインがソースからのファイルセット(チャート、モジュール、compose ファイル)をレンダリングするかどうかです。 |
synthesized | 真偽値 | はい | プラグインが合成されたワークロードをレンダリングするかどうかです。 |
artifacts_standalone | 真偽値 | はい | プラグインがスタンドアロンのアーティファクトのみのノード(インポートされたアーティファクトドキュメントを持ち、ソースもワークロードも持たないノード)をレンダリングするかどうかです。 |
追加のプロパティは許可されません。
ArtifactDelimiters
プラグインがインポートされたアーティファクトファイルに適用する Go テンプレートの区切り文字のペアで、デフォルトのペアと異なる場合に報告されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
left | string | はい | 開始区切り文字です。 |
right | string | はい | 終了区切り文字です。 |
追加のプロパティは許可されません。
AssemblyNameAnnotation
解決された値がプラグインの組み立てられたアーティファクトの名前となる境界アノテーションで、プラグインがディスパッチグループに寄与する境界を 1 つの名前付きアセンブリにまとめる場合に報告されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
annotation | string | はい | プラグインが組み立てられたアーティファクトの名前を読み取る境界アノテーションのキーです。 |
require_unique | 真偽値 | いいえ | 1 つのディスパッチグループに寄与するすべての境界が、アノテーションの解決された値で一致しなければならないかどうかです。true の場合、寄与する境界がアノテーションを異なる値に解決するグループはビルドを停止させます。false の場合、プラグインは最初に解決された値を受け入れます。 |
追加のプロパティは許可されません。
ImporterContract
インポーターが自身のフォーマットについて、それを公開すること以上に宣言する内容、すなわちそれらのフォーマットのソースを認識するためのシグネチャです。インポートがフォーマットを指定しない場合、ホストはインポートの選択対象となるすべてのインポーター(ワークスペースのカタログ内のインポーターと、バイナリがその Plugin エンティティを持つコンパイラのコアインポーター)が記録したシグネチャを読み取り、どのフォーマットが何であるかを知らないまま各シグネチャをソースと照合し、シグネチャが一致した唯一のインポーターのフォーマットとしてソースを読み取ります。どのシグネチャにも一致しないソースは、フォーマットの指定を求めて拒否され、複数のフォーマットのシグネチャに一致するソースは、それらを挙げて拒否されます。Plugin エンティティは同じリストを記録し、ホストは describe() の報告がその記録と異なるインポーターを拒否します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
detect | DetectSignature[] | いいえ | このインポーターのフォーマットのソースを認識するシグネチャで、宣言された順序に並びます。いずれか 1 つが一致すればソースは認識されます。インポーターに認識されたソースは、そのインポーターが公開するすべてのフォーマットとして認識されるため、複数のフォーマットを公開するインポーターではすべての一致が曖昧として拒否されます。ソースを認識させる必要があるインポーターは 1 つのフォーマットを公開します。存在しないか空の場合はシグネチャを宣言せず、インポーターのフォーマットには名前を指定することでのみ到達できます。 |
追加のプロパティは許可されません。
DetectSignature
ソースを認識する 1 つの方法です。ソースを読み取る構文、シグネチャが適用されるファイル名、解析されたツリーが満たさなければならない述語から成ります。名前がファイルパターンのいずれかに一致する(パターンを宣言しない場合は、名前を問わず 1 つのファイルであるソース)ファイルで、そのバイトがその構文で解析でき、解析されたツリーがすべての述語を満たすものに一致します。ディレクトリについては、パターンが選択するディレクトリ内のファイルのいずれかに一致する場合に一致するため、パターンを宣言しないシグネチャはどのディレクトリにも一致しません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
syntax | string | はい | ソースを解析する構文フォーマット(例: json や yaml)で、パーサープラグインが parse: |
files | string[] | いいえ | シグネチャが適用されるファイル名パターンで、区切り文字をスラッシュとして読んだソース名の末尾と照合されます。1 セグメントのパターンはファイル自体の名前と照合され、スラッシュで区切られた複数セグメントのパターンはパスの末尾の同数のセグメントと照合されます。そのため .vscode/mcp.json は .vscode という名前のディレクトリ内の mcp.json という名前のファイルに一致します。セグメント内では、* は任意の文字の並びに、? は 1 文字に、[…] はクラスの 1 文字に一致します。いずれかのパターンが一致すればシグネチャが適用されます。正しい形式でないパターンはロード時に拒否されます。存在しないか空の場合、シグネチャは名前を問わず 1 つのファイルであるソースに適用され、ディレクトリのファイルには適用されません。インポーターのシグネチャのパターンは、インポートがディレクトリのどのファイルをインポーターに渡すかを決めるものでもあります。 |
match | PathMatch[] | いいえ | 解析されたツリーが、宣言された順序ですべて満たさなければならない述語です。存在しないか空の場合は、その構文で解析できること以外にツリーに何も求めません。 |
追加のプロパティは許可されません。
PathMatch
解析されたツリーに対する 1 つの述語です。パスが到達する値、その値がなるべき種類、および任意で値が等しいか先頭が一致すべき文字列から成ります。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
path | string | はい | 述語がツリーのどこを見るかで、ツリーの最上位からキーをドットでつないで記述します。data.nodes は最上位の data オブジェクトの nodes メンバーを指します。0 以上の整数として書かれたセグメントは、0 から数えた配列のその位置を選択するため、nodes.0.type は最初のノードの type を指します。それ以外のセグメントはオブジェクトのメンバーを選択します。ドットを含むキーは指定できません。1 文字以上です。 |
is | string (enum) | はい | パスが到達すべきものです。present は null を含む任意の種類の値に到達した場合に成立し、absent は何にも到達しない場合に成立します。object、array、string、number、boolean は、それぞれその種類の値に到達した場合に成立します。許可される値: "present", "absent", "object", "array", "string", "number", "boolean" |
equals | string | いいえ | パスが到達する値が完全に等しくなければならない文字列です。文字列でない値がこれと等しくなることはありません。1 つの述語に宣言できるのは equals と prefix のうち最大 1 つであり、両方を宣言する述語はロード時に拒否されます。1 文字以上です。 |
prefix | string | いいえ | パスが到達する値の先頭が一致しなければならない文字列です。文字列でない値の先頭がこれと一致することはありません。1 つの述語に宣言できるのは equals と prefix のうち最大 1 つであり、両方を宣言する述語はロード時に拒否されます。1 文字以上です。 |
追加のプロパティは許可されません。