示例

为什么例子很重要#

示例将 UAI-1 从书面规范转变为团队可以与运行代码进行比较的内容。它们展示了配置文件声明、出处、有效负载结构和预期结果如何在真实交换中出现。

灯具如何连接到标准记录#

• 每个示例都应该映射回相关的 UAI-1 行为。
• 每个灯具应与已发布的 模式。
• 每个示例都应该指向匹配的 注册表 标识符，以便读者知道它所执行的配置文件。
• 验证器应该能够使用相同的装置作为回归基线。

实施者应如何使用示例#

1. 将您的候选人消息与最近发布的赛程进行比较。
2. 在审核期间保持可读的键控JSON，并仅将优化的传输表格用作传输选择。
3. 使用示例向下游团队解释预期的成功和失败模式。

目前的固定角色#

• uai.intent.request.v1 显示在任何响应或运行时映射发生之前声明的请求的样子。
• uai.intent.response.v1 显示附加到先前请求的成功或信息丰富的结果的预期公开形式。
• uai.capability.statement.v1 显示面向发现的功能元数据如何声明支持的配置文件和操作。
• uai.error.v1 显示了当验证或执行无法顺利进行时读者应该预期的稳定的公共故障形状。
• uai.conformance.result.v1 显示验证器生成的证据记录，可以进入 CI 日志、审查数据包和发行说明。

赛程如何成为公开发布的证据#

• 通过运行匹配的夹具 验证器 在调用实现一致性之前。
• 将所得证据带入相关部门 实施轨道 跟踪，以便读者可以看到实际发生了什么。
• 使用 变更日志 和 新闻 当装置更新改变集成期望时。
• 使用 参考资料与贡献者 当您需要围绕已发布的测试样例稳定的发现和引用链接时。

已发布的示例目录#

下面的示例是验证器和公共注册表记录使用的版本控制装置。

[uaix_example_catalog]

下一步#

继续前往 验证器 将这些示例支持的期望转化为可重复的验证证据，然后将结果记录带入 实施轨道。