跳转到内容
AggregaAggrega
选择语言: 简体中文
本页面由机器翻译。阅读英文原文。

Aggrega 目录(MappingLibrary)schema

自动生成的参考文档。请勿手动编辑——请从发布的 JSON Schema 重新生成。

Schema id:https://aggrega.ai/schemas/mappinglibrary-v1beta1.schema.json

一组可复用的 Go 模板片段,Recipes 和 FeatureRecipes 在渲染时通过 valuesMapping: { $import: ... } 使用它们。第 3 层——供需要跨 Recipe 复用映射的目录选择性启用。单一编写模式:仅限 Go 模板。

有关编写 MappingLibrary 实体的说明性指南,请参阅 MappingLibrary 编写参考;本页记录该参考所描述的结构化 schema。

顶层类型: object

属性

属性类型必需描述
apiVersionconst “aggrega.ai/v1beta1”是常量:"aggrega.ai/v1beta1"
kindconst “MappingLibrary”是常量:"MappingLibrary"
metadataobject是
specobject是该 MappingLibrary 的内容。spec.mappings 为必填项,且必须至少声明一个条目。spec 带有 additionalProperties: false——在信封层级不接受任何并行编写模式。单一编写模式的设计使 Recipe 渲染保持统一(全程使用 Go 模板),并避免作者在使用导入的片段时被迫在渲染中途切换求值模型。

不允许其他属性。

mappinglibrary.metadata

属性类型必需描述
namestring是该库的 PascalCase 标识符。它是裸名称身份引用 #/mappings/ 中的 名称;版本由每个 Release 的锁文件提供,引用及任何派生标识符中都不包含注册表主机。模式:^[A-Z][A-Za-z0-9]*$。
versionstring是该库的严格语义化版本(例如 1.0.0)。使用方可以在裸名称引用(:#/mappings/)中以可选的 :<version> 最低版本下限断言该版本;解析后的版本由每个 Release 的锁文件决定。模式:^(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否对该库涵盖内容的简要概述。
labelsmap of string否作者声明的标签。编译器对内容保持中立,不解释标签值:它们是不透明的元数据,供读取该库的任何程序用来匹配。
annotationsmap of string否作者声明的注解。与标签一样,作为不透明元数据处理。

不允许其他属性。

mappinglibrary.spec

该 MappingLibrary 的内容。spec.mappings 为必填项,且必须至少声明一个条目。spec 带有 additionalProperties: false——在信封层级不接受任何并行编写模式。单一编写模式的设计使 Recipe 渲染保持统一(全程使用 Go 模板),并避免作者在使用导入的片段时被迫在渲染中途切换求值模型。

属性类型必需描述
mappingsmap of string是由可复用 Go 模板片段组成的命名映射。每个条目的正文对信封验证是不透明的——内容语义由 Go 模板解析器在使用时处理。键:PascalCase 标识符。条目键会出现在规范引用 URL(#/mappings/<name>)中;信封层级的约束可防止非 PascalCase 键在目录生态中传播。模式:^[A-Z][A-Za-z0-9]*$。至少 1 个条目。

不允许其他属性。