API/ValidationReport

数据对象

ValidationReport

理解完整校验结果、声明层状态以及结构化问题列表。

ValidationReportvalidate_octx() 返回的不可变校验报告。普通格式、摘要或结构错误会记录在报告中,不需要调用方解析异常文本。

获取对象

python
from octx import validate_octx

report = validate_octx("product-guide.octx")

if not (report.valid and report.fully_validated):
    for issue in report.issues:
        print(issue.severity, issue.code, issue.path, issue.message)

字段

字段作用
validOCTX 格式和所有已执行的已知层是否有效。
fully_validated当前安装是否理解并完整验证了全部声明层。
formatOCTX 格式的 LayerResult
capabilitiesCapability 名称到 LayerResult 的只读映射。
issues全部 ValidationIssue
issue_codes报告中错误码的只读集合。

相关对象

LayerResult 包含 declaredvalidversionfully_validated 和该层的 issues

ValidationIssue 包含 codeseveritymessage,以及可选的 pathlinerecord_id

发布或高信任导入通常应同时要求 validfully_validatedTrue。使用 report.to_dict() 可以得到 JSON 可序列化结构。