9.3. Apicurio Registry アーティファクトメタデータ

contentId

integer

Apicurio Registry のアーティファクトコンテンツの一意の識別子。アーティファクトバージョンに同一のコンテンツがある場合、同じコンテンツ ID を複数のアーティファクトバージョンで共有できます。たとえば、コンテンツ ID 4 は、コンテンツが同じ複数のアーティファクトバージョンで使用できます。

createdBy

string

アーティファクトを作成したユーザーの名前。

createdOn

date

アーティファクトが作成された日時 (例: 2023-10-11T14:15:28Z)。

globalId

integer

Apicurio Registry 内のアーティファクトバージョンのグローバルに一意な識別子。たとえば、Apicurio Registry で作成された最初のアーティファクトバージョンには、グローバル ID 1 が割り当てられます。

modifiedBy

string

アーティファクトを変更したユーザーの名前。

modifiedOn

date

アーティファクトが変更された日時 (例: 2023-10-11T14:15:28Z)。

type

ArtifactType

サポートされているアーティファクトのタイプ (AVRO、OPENAPI、PROTOBUF など)。

groupId

string

Apicurio Registry 内のアーティファクトグループの一意の識別子 (development または production など)。Apicurio Registry Web コンソールを使用してアーティファクトを作成する時にグループ ID を指定しない場合は、default に設定されます。Apicurio Registry REST API、Java クライアント、または Maven プラグインを使用する場合は、グループ ID を指定する必要があります。

id

string

Apicurio Registry 内のアーティファクトの一意の識別子。アーティファクト ID を指定することも、Apicurio Registry によって生成された UUID (8d168cad-1865-4e6c-bb7e-04e8be005bea など) を使用することもできます。アーティファクトの異なるバージョンは同じアーティファクト ID を使用しますが、グローバル ID は異なります。

references

ArtifactReference の配列

アーティファクトに含まれるアーティファクト参照のオプションのセット。アーティファクトの作成時に指定できます。[{"groupId":"my-group","artifactId":"ItemId","version":"1","name":"com.example.common.ItemId"}] の簡単な例は、単一のアーティファクト参照を示しています。

version

integer

アーティファクトの最新バージョン。生成されたバージョン (例: 3) を使用することも、Apicurio Registry REST API または Maven プラグインを使用してバージョン (例: 2.1.6) を指定することもできます。

description

string

アーティファクトの意味のあるオプションの説明 (例: This is a simple OpenAPI for testing)。説明を入力することも、すでに提供されている場合は、OpenAPI および AsyncAPI アーティファクトの info セクションから自動的に検出することもできます。

labels

string の配列

アーティファクトのフィルターと検索に使用されるオプションのコンマ区切りのラベルのリスト (例: test,protobuf)。ユーザーによって指定されます。

name

string

人間が判読できるアーティファクトのオプションの名前 (例: My first Avro schema)。説明を入力することも、title フィールドに値がある場合は、OpenAPI および AsyncAPI アーティファクトの info セクションから自動的に検出することもできます。

properties

map

アーティファクトに関連付けられたユーザー定義の名前と値のペアのオプションのリスト。名前と値は文字列である必要があります (例: my-key および my-value)。

state

ArtifactState

アーティファクトの最新の状態: ENABLED、DISABLED、または DEPRECATED。デフォルトでは ENABLED に設定されています。