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

Aggrega 目录(SchemaLibrary)schema

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

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

一组可复用的 JSON Schema 2020-12 定义,目录内容(Components、Features 等)可通过裸名称身份引用 #/schemas/ 对其进行 $ref(版本由每个 Release 的锁文件提供;引用中不出现注册表主机)。第 3 层——供需要跨 Component 复用 schema 的目录按需启用。

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

顶层类型: object

属性

属性类型必需描述
apiVersionconst “aggrega.ai/v1beta1”是常量:"aggrega.ai/v1beta1"
kindconst “SchemaLibrary”是常量:"SchemaLibrary"
metadataobject是
specobject是该 SchemaLibrary 的内容。spec.schemas 为必需项,且必须声明至少一个条目;spec.templates 为可选项,仅在库使用参数化辅助模板时出现。

不允许其他属性。

schemalibrary.metadata

属性类型必需描述
namestring是库的 PascalCase 标识符。它是裸名称身份引用 #/schemas/ 中的 名称;版本由每个 Release 的锁文件提供,注册表主机不会进入该引用或任何派生标识符。模式:^[A-Z][A-Za-z0-9]*$。
versionstring是库的严格语义化版本(例如 1.0.0)。每个 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否作者声明的注解。与标签一样,作为不透明元数据处理。

不允许其他属性。

schemalibrary.spec

该 SchemaLibrary 的内容。spec.schemas 为必需项,且必须声明至少一个条目;spec.templates 为可选项,仅在库使用参数化辅助模板时出现。

属性类型必需描述
schemasmap of object是可复用 schema 定义的命名映射。每个条目的内容在解析时由紧凑格式编译器校验;信封层校验仅检查结构性包装。键:PascalCase 标识符——^[A-Z][A-Za-z0-9]*$。条目键出现在裸名称身份引用(<Library>#/schemas/<name>)中;信封层约束可防止非 PascalCase 的键在目录生态中传播。至少 1 个条目。
templatesmap of object否可选的参数化辅助模板命名映射。Schema 条目通过 $instantiate: 按名称引用模板;仅支持字面标量替换——不支持嵌入 Go 模板、条件或循环。库的替换层有意比完整的模板求值更窄,使编写工作保持在 schema 语言之内,而不是引入单独的模板机制。键:PascalCase 标识符——^[A-Z][A-Za-z0-9]*$。与 schema 条目键遵循相同的信封层约束;模板名称在实例化时通过 $instantiate: 引用。

不允许其他属性。