搜索

9.3. Apicurio Registry 工件元数据

download PDF

当工件添加到 Apicurio Registry 时,会创建一组元数据属性,并与工件内容一起存储。这个元数据由系统生成的或用户生成的属性组成,它们是只读的,您可以在创建工件后更新的属性。

表 9.3. Apicurio Registry 系统生成的元数据
属性类型描述

contentId

整数

Apicurio Registry 中工件内容的唯一标识符。当工件版本有相同的内容时,同一内容 ID 可以被多个工件版本共享。例如,内容 ID 4 可用于具有相同内容的多个工件版本。

createdBy

string

创建工件的用户的名称。

createdOn

date

创建工件的日期和时间,例如 2023-10-11T14:15:28Z

globalId

整数

Apicurio Registry 中工件版本的全局唯一标识符。例如,一个全局 ID 1 被分配给 Apicurio Registry 中创建的第一个工件版本。

modifiedBy

string

修改工件的用户的名称。

modifiedOn

date

修改工件的日期和时间,例如 2023-10-11T14:15:28Z

type

ArtifactType

支持的工件类型,如 AVROOPENAPIPROTOBUF

表 9.4. Apicurio Registry 用户提供或系统生成的元数据
属性类型描述

groupId

string

Apicurio Registry 中工件组的唯一标识符,如 developmentproduction。当使用 Apicurio Registry web 控制台创建工件时,如果没有提供组 ID,则这 设置为默认。在使用 Apicurio Registry REST API、Java 客户端或 Maven 插件时,您必须提供组 ID。

id

string

Apicurio Registry 中工件的唯一标识符。您可以提供工件 ID,或使用 Apicurio Registry 生成的 UUID,例如 8d168cad-1865-4e6c-bb7e-04e8be005bea。工件的不同版本使用相同的工件 ID,但具有不同的全局 ID。

参考

ArtifactReference 数组

工件中包含的可选工件引用集合,您可以在创建工件时提供它们。以下简单示例显示了一个工件引用: [{"groupId":"my-group","artifactId":"ItemId":"version":"1","name":"com.example.common.ItemId"}].

version

整数

工件的最新版本。您可以使用生成的版本,如 3,或使用 Apicurio Registry REST API 或 Maven 插件提供版本,如 2.1.6

表 9.5. Apicurio Registry 可编辑的元数据
属性类型描述

description

string

工件的可选有意义的描述,例如,这是测试 的简单 OpenAPI。您可以提供描述,如果已提供,可以从 OpenAPI 和 AsyncAPI 工件的 info 部分自动发现它。

labels

字符串数组

可选以逗号分隔的标签列表,用于过滤和搜索工件,如 test,protobuf。由用户提供的。

name

string

工件的可选可读名称,如 My first Avro schema。您可以提供描述,如果 title 字段有一个值,则可以从 OpenAPI 和 AsyncAPI 工件的 info 部分自动发现它。

属性

map

与工件关联的用户定义的 name-value 对的可选列表。name 和 value 必须是字符串,如 my-keymy-value

state

ArtifactState

工件的最新状态: ENABLEDDISABLEDDEPRECATED。默认为 ENABLED

更新工件元数据

  • 您可以使用 Apicurio Registry REST API 或 Web 控制台更新可编辑的元数据属性集合。
  • 您只能使用 Apicurio Registry REST API 更新 state 属性。

其他资源

如需了解更多详细信息,请参阅 Apicurio Registry REST API 文档中的 /artifacts/{artifactId}/meta 端点。

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.