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

Aggrega Developer Intent(Aggregate)スキーマ

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

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

再帰的でパラメータ化された AI アーキテクチャです。ビルドのルートと再利用可能なモジュールの両方として機能します。

Aggregate エンティティの記述に関する解説は Aggregate 記述リファレンスを参照してください。このページでは、そのリファレンスが説明する構造スキーマを記載します。

トップレベルの型: object

プロパティ

プロパティ種類必須説明
apiVersionconst “aggrega.ai/v1beta1”はい定数: "aggrega.ai/v1beta1"
kindconst “Aggregate”はい定数: "Aggregate"
metadataobjectはい
defsstring[]いいえ標準の YAML アンカー(& と *)用の任意のブロックです。コンパイラ向けのフラットな O(1) 辞書を維持しつつ、Aggregate を DRY に保ちます。Manifest の同等のブロックと対応しています。
specobjectはいDeveloper Intent のサーフェスです。グローバルなパラメータ契約、ネストされた aggregate のインポート、エクスポートされたコンポーネントの公開 API、サブシステムのグループ化、およびモジュールを構成するコンポーネントインスタンスを含みます。

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

aggregate.metadata

プロパティ種類必須説明
namestringはい1 文字以上。
versionstringはいaggregate モジュールの厳密なセマンティックバージョニング。パターン: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$。
descriptionstringいいえ
maintainersobject[]いいえこのエンティティを所有するメンテナーの一覧です。
licensestringいいえこのエンティティが記述するソフトウェアのライセンスの SPDX 識別子です(MIT や AGPL-3.0 など)。記録するのはそのソフトウェアの条件であり、このファイルの条件ではありません。
repositorystringいいえソースファイルが置かれている Git リポジトリの URL です。
homestringいいえこのエンティティのホームページ、wiki、またはドキュメントの URL です。
keywordsstring[]いいえUI での発見性を高めるための説明的なキーワードの一覧です。
labelsstring のマップいいえカタログでの発見、ポリシー評価、Studio/IDE でのフィルタリングに使うモジュールレベルのダックタイピング用ラベルです。これらのラベルは、再利用可能なモジュールとしての Aggregate のアイデンティティを記述します(例: aggregate.aggrega.ai/tier: infrastructure、aggregate.aggrega.ai/compliance: pci-dss)。子のコンポーネントノードにはカスケードしません。コンポーネントのラベルは、Domain 2 の Component カタログエンティティからのみ取得されます。

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

aggregate.metadata.maintainers[]
プロパティ種類必須説明
namestringはい
emailstringいいえ
urlstringいいえ

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

aggregate.spec

Developer Intent のサーフェスです。グローバルなパラメータ契約、ネストされた aggregate のインポート、エクスポートされたコンポーネントの公開 API、サブシステムのグループ化、およびモジュールを構成するコンポーネントインスタンスを含みます。

プロパティ種類必須説明
parametersobject のマップいいえグローバルな環境契約です。各エントリは、コンパクト形式の語彙のサブセット(type、description、default、enum、min/max、minLength/maxLength、pattern、format、validate、validateMessage、required、items、valuesType、properties)を記述する型付き契約オブジェクトです。ネストされた構造は、型付き形式の properties: サブフィールドで表現します。Release での充足は、インライン(parameters: {…})または単一ソースのファイルインポート(parameters: {$import: })で行えます。パラメータ契約レイヤーは、パラメータの補間の前に、マージされたマップをこの契約に照らして検証します。語彙の全体は、言語リファレンスの Aggregate のページで説明しています。
aggregatesobject のマップいいえインポートされたモジュールとして機能するネストされた aggregate です。キー: 1 文字以上の英字、数字、アンダースコア、またはハイフン。ドットは使用できません。パターン: ^[a-zA-Z0-9_-]+$。
exportedComponentsstring のマップいいえ公開 API インターフェースです。公開された名前を内部のコンポーネント ID にマッピングします。このモジュールをインポートする親の Aggregates は、これらの公開名でコンポーネントを参照します。
subsystemssubsystem のマップいいえAggregate のコンポーネントを名前付きの論理的なサブシステムにグループ化したものです。トップレベルの components とは相互に排他的で、両方を宣言すると拒否されます。作成者が default と名付けたサブシステムは通常の宣言済みサブシステムであり、components のみの Aggregate に対してコンパイラが生成する合成 default とは区別されます。キー: 1 文字以上の英字、数字、アンダースコア、またはハイフン。ドットは使用できません。パターン: ^[a-zA-Z0-9_-]+$。
componentscomponent_instance のマップいいえこの Aggregate を構成する論理的なアトミックコンポーネントのマップで、トップレベルに直接記述します。トップレベルの components と subsystems は相互に排他的で、両方を宣言すると拒否されます。ここに components を(subsystems なしで)記述すると、コンパイラはロード時にそれらを合成された default サブシステムに組み込み、IR はそのサブシステムを合成されたものとして印付けします。キー: 1 文字以上の英字、数字、アンダースコア、またはハイフン。ドットは使用できません。パターン: ^[a-zA-Z0-9_-]+$。

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

定義

inject_delivery

単一の配信メカニズムで、エントリの配列として記述します。各エントリは ‘in’(ローカル識別子。環境変数名、ファイルパス、引数フラグ、またはメカニズム固有のカスタムキー)に加えて、‘from’(解決する provides キー)または ‘value’(リテラル文字列。self-inject の解決時に評価される Go テンプレート式を含めることもできます)のいずれか一方をちょうど 1 つ持ちます。‘from’ は、uses[].inject のコンテキストではターゲットの provides に対して、アタッチメントの features..inject のコンテキストではそのアタッチメントの FeatureRecipe が公開する provides に対して、component.inject のコンテキストではコンポーネント自身の provides に対して解決されます。アタッチメントの features..inject で、FeatureRecipe が公開していないキーを ‘from’ が指定するとビルドは停止します。ただし、その FeatureRecipe がアタッチメントのレンダリングコンテキストに対して評価するテンプレート(その valuesMapping、workload、artifacts、omits、またはパイプラインステップの with や when。injectMapping は含みません)の中で、アタッチメントのエントリを自ら .inject で読み取る場合は例外で、そのキーはコンポーネントの .context.inject を通じて配信されるキーではなく、その FeatureRecipe 自身が消費するキーとなります。‘value’ は component.inject でのみ配信されます。uses[].inject またはアタッチメントの features..inject で ‘value’ を持つエントリはビルドを停止させます。これらのブロックは、別のエンティティが公開するキーしか配信しないためです。

型: object[]

inject_block

注入先に依存しないインジェクションのルーティングです。ローカル変数を、ターゲットの provides キー(uses[].inject)、アタッチメントの FeatureRecipe が公開する provides キー(features..inject)、またはリテラル文字列/テンプレート式とコンポーネント自身の provides キー(component.inject)にマッピングします。各配信メカニズム(env、file、arg、またはカスタム)は {in, from?, value?} エントリの配列として記述します。provides の参照には明示的な ‘from’ を、リテラルには ‘value’ を使います。カスタムメカニズムには all 以外の任意の名前を付けられます。テンプレートはすべてのメカニズムを 1 つのビューにマージしたものを .context.inject.all で読み取るため、その名前のメカニズムはこのビューに隠されてしまいます。その名前を付けるとビルドは停止します。

プロパティ種類必須説明
envinject_deliveryいいえ単一の配信メカニズムで、エントリの配列として記述します。各エントリは ‘in’(ローカル識別子。環境変数名、ファイルパス、引数フラグ、またはメカニズム固有のカスタムキー)に加えて、‘from’(解決する provides キー)または ‘value’(リテラル文字列。self-inject の解決時に評価される Go テンプレート式を含めることもできます)のいずれか一方をちょうど 1 つ持ちます。‘from’ は、uses[].inject のコンテキストではターゲットの provides に対して、アタッチメントの features..inject のコンテキストではそのアタッチメントの FeatureRecipe が公開する provides に対して、component.inject のコンテキストではコンポーネント自身の provides に対して解決されます。アタッチメントの features..inject で、FeatureRecipe が公開していないキーを ‘from’ が指定するとビルドは停止します。ただし、その FeatureRecipe がアタッチメントのレンダリングコンテキストに対して評価するテンプレート(その valuesMapping、workload、artifacts、omits、またはパイプラインステップの with や when。injectMapping は含みません)の中で、アタッチメントのエントリを自ら .inject で読み取る場合は例外で、そのキーはコンポーネントの .context.inject を通じて配信されるキーではなく、その FeatureRecipe 自身が消費するキーとなります。‘value’ は component.inject でのみ配信されます。uses[].inject またはアタッチメントの features..inject で ‘value’ を持つエントリはビルドを停止させます。これらのブロックは、別のエンティティが公開するキーしか配信しないためです。
fileinject_deliveryいいえ単一の配信メカニズムで、エントリの配列として記述します。各エントリは ‘in’(ローカル識別子。環境変数名、ファイルパス、引数フラグ、またはメカニズム固有のカスタムキー)に加えて、‘from’(解決する provides キー)または ‘value’(リテラル文字列。self-inject の解決時に評価される Go テンプレート式を含めることもできます)のいずれか一方をちょうど 1 つ持ちます。‘from’ は、uses[].inject のコンテキストではターゲットの provides に対して、アタッチメントの features..inject のコンテキストではそのアタッチメントの FeatureRecipe が公開する provides に対して、component.inject のコンテキストではコンポーネント自身の provides に対して解決されます。アタッチメントの features..inject で、FeatureRecipe が公開していないキーを ‘from’ が指定するとビルドは停止します。ただし、その FeatureRecipe がアタッチメントのレンダリングコンテキストに対して評価するテンプレート(その valuesMapping、workload、artifacts、omits、またはパイプラインステップの with や when。injectMapping は含みません)の中で、アタッチメントのエントリを自ら .inject で読み取る場合は例外で、そのキーはコンポーネントの .context.inject を通じて配信されるキーではなく、その FeatureRecipe 自身が消費するキーとなります。‘value’ は component.inject でのみ配信されます。uses[].inject またはアタッチメントの features..inject で ‘value’ を持つエントリはビルドを停止させます。これらのブロックは、別のエンティティが公開するキーしか配信しないためです。
arginject_deliveryいいえ単一の配信メカニズムで、エントリの配列として記述します。各エントリは ‘in’(ローカル識別子。環境変数名、ファイルパス、引数フラグ、またはメカニズム固有のカスタムキー)に加えて、‘from’(解決する provides キー)または ‘value’(リテラル文字列。self-inject の解決時に評価される Go テンプレート式を含めることもできます)のいずれか一方をちょうど 1 つ持ちます。‘from’ は、uses[].inject のコンテキストではターゲットの provides に対して、アタッチメントの features..inject のコンテキストではそのアタッチメントの FeatureRecipe が公開する provides に対して、component.inject のコンテキストではコンポーネント自身の provides に対して解決されます。アタッチメントの features..inject で、FeatureRecipe が公開していないキーを ‘from’ が指定するとビルドは停止します。ただし、その FeatureRecipe がアタッチメントのレンダリングコンテキストに対して評価するテンプレート(その valuesMapping、workload、artifacts、omits、またはパイプラインステップの with や when。injectMapping は含みません)の中で、アタッチメントのエントリを自ら .inject で読み取る場合は例外で、そのキーはコンポーネントの .context.inject を通じて配信されるキーではなく、その FeatureRecipe 自身が消費するキーとなります。‘value’ は component.inject でのみ配信されます。uses[].inject またはアタッチメントの features..inject で ‘value’ を持つエントリはビルドを停止させます。これらのブロックは、別のエンティティが公開するキーしか配信しないためです。

component_uses_block

コンポーネントが依存先のコンポーネントに対して張る接続で、ソケットをキーとします。各ソケットはターゲットを列挙するか、各接続にエイリアスを付けて名前を付けます。エイリアスで名前を付けた接続は、開発者による接続ごとの値と、ソケットが宣言するスロットを埋めるアタッチメントを持つことができます。

キー: 1 文字以上の英字、数字、アンダースコア、またはハイフン。ドットは使用できません。パターン: ^[a-zA-Z0-9_-]+$。

値は string[] or map of object です。

その他のキーは使用できません。

feature_uses_block

アタッチされた Feature が張る接続で、Feature が usesSchema で宣言するソケットをキーとします。各ソケットはターゲットを列挙するか、各接続にエイリアスを付けて名前を付けます。Feature が張る接続は独自のアタッチメントを持ちません。必要な認証情報は、Feature が自身の featuresSchema で宣言するスロットを埋め、Feature と並べてアタッチされます。

キー: 1 文字以上の英字、数字、アンダースコア、またはハイフン。ドットは使用できません。パターン: ^[a-zA-Z0-9_-]+$。

値は string[] or map of object です。

その他のキーは使用できません。

connection_attachment

接続が持つ 1 つのアタッチメントです。接続のソケットが宣言するスロットを埋める Feature と、それに対する開発者の設定から成ります。

プロパティ種類必須説明
typestringはいこのアタッチメントが要求する Feature インターフェースの URI(例: core/referenced-secret:1.0.0)。
descriptionstringいいえこの接続がアタッチメントを持つ理由を説明する任意のドキュメント。
valuesobjectいいえ開発者が指定する Feature の設定で、そのスキーマ宣言によって検証されます。

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

subsystem

プロパティ種類必須説明
descriptionstringいいえこのサブシステムの目的と、それが表す論理的なグループを説明する任意のドキュメント。
annotationsstring、object、または null のマップいいえ開発者がこのサブシステムに記述するアノテーション。値は文字列、構造化オブジェクト(サブキーから値へのマップで、継承した構造化値とサブキーごとにマージされます)、または null です。親サブシステムから継承したキーに明示的に null を指定すると、継承したバインディングがこのサブシステムから取り除かれます(アノテーションによる Feature のオプトアウト)。ここで宣言したアノテーションは、ネストしたサブシステムと内包するコンポーネントに継承され、キーごとにより近いレベルが優先されます。派生した各 IR ノードの .context.annotations.aggregate バケットまでカスケードします。
featuresobject のマップいいえこのサブシステム内のすべてのコンポーネントにアタッチされる横断的なフィーチャー。コンポーネントレベルのフィーチャーと同じスキーマ(type、values、uses、inject)です。グラフの確定時に各コンポーネントへ展開され、実行順序ではコンポーネントレベルのフィーチャーの後に配置されます。キー: 1 文字以上の英字、数字、アンダースコア、またはハイフン。ドットは使用できません。パターン: ^[a-zA-Z0-9_-]+$。
subsystemssubsystem のマップいいえキー: 1 文字以上の英字、数字、アンダースコア、またはハイフン。ドットは使用できません。パターン: ^[a-zA-Z0-9_-]+$。
componentscomponent_instance のマップいいえキー: 1 文字以上の英字、数字、アンダースコア、またはハイフン。ドットは使用できません。パターン: ^[a-zA-Z0-9_-]+$。

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

component_instance

プロパティ種類必須説明
typestringはい要求する抽象 Component を参照として指定します。metadata.name に任意の :version を付けたもの(例: core/api-server:1.0.0)であり、ファイルパスではありません。3 層エンティティ解決モデル(ワークスペースのカタログディレクトリ → キャッシュ → レジストリ)で解決されます。ローカルで作成した Component は、ワークスペースルートの catalog/ 配下、または workspace.catalog_dirs に列挙されたディレクトリに配置します。相対ファイルパスとして書かれた type は、どのカタログにも存在しないエンティティとしてビルドを停止させます。
activeboolean または stringいいえコンパイル後のトポロジにこのコンポーネントが存在するかどうか。boolean、または boolean に解決される必要がある .parameters 上の文字列テンプレートです。false に解決されると、コンポーネントはトポロジから除去され、その uses エッジとアタッチメントにも波及します。値をパラメータから決めると、Release はそのパラメータを満たすことでコンポーネントの有無を切り替えられます。省略時は true です。デフォルト: true
descriptionstringいいえアプリケーションにおけるこのコンポーネントインスタンスの役割を説明する任意のドキュメント。IR グラフへ引き継がれます。
annotationsstring、object、または null のマップいいえこの component に対して開発者が記述するアノテーションです。値は文字列、構造化オブジェクト(サブキーから値へのマップで、継承した構造化値とサブキーごとにマージされます)、または null です。親 subsystem から継承したキーに明示的に null を指定すると、継承されたバインディングがこの component から削除されます(アノテーションによる Feature のオプトアウト)。Component レベルのアノテーションは、継承された subsystem レベルのアノテーションをキーごとに上書きします。同じ subsystem 内の兄弟 component は、それぞれ独自のアノテーションマップを独立して保持します。
valuesobjectいいえComponent に渡される不透明なコグニティブプロパティ。そのスキーマによって検証されます。
usescomponent_uses_blockいいえコンポーネントが依存先のコンポーネントに対して張る接続で、ソケットをキーとします。各ソケットはターゲットを列挙するか、各接続にエイリアスを付けて名前を付けます。エイリアスで名前を付けた接続は、開発者による接続ごとの値と、ソケットが宣言するスロットを埋めるアタッチメントを持つことができます。
injectinject_blockいいえコンポーネントレベルの自己注入。コンポーネント自身の値(‘value:’ 経由)または自身の provides キー(‘from:’ 経由)を配信パイプ(.context.inject)に直接注入します。Component カタログエンティティが対応するメカニズムとともに ‘spec.inject’ を宣言している場合にのみ許可されます。uses[].inject で宣言されたキーと衝突する inject キーは、inject ソース間で重複した配信キーとしてビルドを停止させます。
featuresobject のマップいいえこのコンポーネントにアタッチされる Features。作成者が各アタッチメントに付けるインスタンス名をキーとします。これが唯一のアタッチメント面です。運用 Feature、資格情報 Feature(feature.aggrega.ai/kind: secret のラベルを持つもの)、アイデンティティ Feature はすべて、同じキーワード、同じ形でここにアタッチされます。これらの違いはアタッチメントが何を生成するかであり、どのように宣言されるかではありません。インスタンス名が、Component が featuresSchema で宣言するスロットと一致するアタッチメントは、そのスロットを満たします。それ以外のインスタンス名は自由なアタッチメントです。キー: 1 文字以上の英字、数字、アンダースコア、またはハイフン。ドットは使用できません。パターン: ^[a-zA-Z0-9_-]+$。

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