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

Aggrega カタログ(SchemaLibrary)スキーマ

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

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

再利用可能な JSON Schema 2020-12 定義のコレクションです。カタログのコンテンツ(Components、Features など)は、ベアネームのアイデンティティ参照 #/schemas/ を介して $ref で参照できます(バージョンは Release ごとのロックファイルによって提供され、参照にレジストリホストは含まれません)。Tier 3 — Component をまたいだスキーマの再利用を必要とするカタログ向けのオプトイン機能です。

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

トップレベルの型: object

プロパティ

プロパティ種類必須説明
apiVersionconst “aggrega.ai/v1beta1”はい定数: "aggrega.ai/v1beta1"
kindconst “SchemaLibrary”はい定数: "SchemaLibrary"
metadataobjectはい
specobjectはいSchemaLibrary のコンテンツです。spec.schemas は必須で、少なくとも 1 つのエントリを宣言する必要があります。spec.templates は省略可能で、ライブラリがパラメータ化されたヘルパーを使用する場合にのみ存在します。

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

schemalibrary.metadata

プロパティ種類必須説明
namestringはいライブラリの PascalCase 識別子です。ベアネームのアイデンティティ参照 #/schemas/ における 名にあたります。バージョンは Release ごとのロックファイルによって提供され、参照にも派生する識別子にもレジストリホストは含まれません。パターン: ^[A-Z][A-Za-z0-9]*$。
versionstringはいライブラリの厳密なセマンティックバージョニング(例: 1.0.0)です。Release ごとのロックファイルはライブラリごとに 1 つのバージョンを固定します。パターン: ^(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いいえライブラリが扱う内容の簡潔な概要です。
labelsstring のマップいいえ作成者が宣言するラベルです。コンパイラは内容に対して中立であり、ラベルの値を解釈しません。ラベルは不透明なメタデータであり、ライブラリを読むものが照合に使うために運ばれます。
annotationsstring のマップいいえ作成者が宣言するアノテーションです。ラベルと同様に、不透明なメタデータとして扱われます。

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

schemalibrary.spec

SchemaLibrary のコンテンツです。spec.schemas は必須で、少なくとも 1 つのエントリを宣言する必要があります。spec.templates は省略可能で、ライブラリがパラメータ化されたヘルパーを使用する場合にのみ存在します。

プロパティ種類必須説明
schemasobject のマップはい再利用可能なスキーマ定義の名前付きマップです。各エントリの内容は、パース時にコンパクト形式のコンパイラによって検証されます。エンベロープレベルの検証では構造上のラッピングのみを確認します。キー: PascalCase 識別子 — ^[A-Z][A-Za-z0-9]*$。エントリのキーはベアネームのアイデンティティ参照(<Library>#/schemas/<name>)に現れます。エンベロープレベルの制約により、PascalCase でないキーがカタログのエコシステム全体に広がることを防ぎます。1 エントリ以上です。
templatesobject のマップいいえパラメータ化されたヘルパーの名前付きマップ(省略可能)です。スキーマのエントリは $instantiate: を介して名前でテンプレートを参照します。リテラルのスカラー置換のみが可能で、埋め込みの Go テンプレート、条件分岐、ループはありません。ライブラリの置換レイヤーは、完全なテンプレート評価よりも意図的に狭くされており、別のテンプレート機構を導入せずに、記述がスキーマ言語の中にとどまるようにしています。キー: PascalCase 識別子 — ^[A-Z][A-Za-z0-9]*$。スキーマのエントリキーと同じエンベロープレベルの規律が適用されます。テンプレート名はインスタンス化の時点で $instantiate: を介して参照されます。

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