好味优选工程标准

公共接口和导出格式规范

公共接口和导出格式规范的数据结构、验证规则和访问边界。

文件编号
GTA-DATA-004
版本
1.0.0
状态
现行
文件类型
数据规格
结构化独立评审会议的俯视图

标准正文

阅读本标准

可通过目录在条款之间跳转,也可在文件内搜索、调整字号或打印留存。

资料性

1 目的

本文档定义了机器可读对象、验证规则和访问边界 公共接口和导出格式规范 在好味优选工程标准体系中的评审方法与控制要求。

禁止

2 范围

本文件适用于以下方法明确规定的要求、决定、记录、控制与输出: 公共接口和导出格式规范。星级适用范围和排除范围由以下机构控制 GTA-STD-100;本文件不得增加其他评定维度。这里规定的操作前提会影响评审是否有效,但不构成产品认证。

要求

3 责任与解释

数据与发布负责人 负责管理 GTA-DATA-004; 标准负责人 负责批准本文件。规范性用语、受控术语、稳定的条款标识、政策常量及生成内容,应依据 GTA-GOV-002, GTA-GOV-005及受控登记册进行解释。

资料性

3.1 注册关系

关系方向相关文件
publishes下游GTA-REG-001
publishes下游GTA-REG-002
publishes下游GTA-REG-003
controls_release_of参评GTA-PUB-005
governed_by下游GTA-GOV-001
资料性

4 要求

要求数据与发布负责人

GTA-DATA-004-R001 — 公共文档 API

数据与发布负责人 应提供受控元数据、条款、关系、定义和导航。

要求数据与发布负责人

GTA-DATA-004-R002 — 星级结果 API

数据与发布负责人 应提供授权的产品标识、星级、短语、注释、索引、标记和验证。

要求数据与发布负责人

GTA-DATA-004-R003 — 限制字段排除

数据与发布负责人 应防止匿名映射、评审员身份、原始反应、冲突和导出非公开结果。

要求数据与发布负责人

GTA-DATA-004-R004 — 资源标识

数据与发布负责人 应使用稳定的路径、标识符、锚点和规范关系。

要求数据与发布负责人

GTA-DATA-004-R005 — 表示

数据与发布负责人 应支持结构化数据和读者呈现而不改变含义。

要求数据与发布负责人

GTA-DATA-004-R006 — 过滤

数据与发布负责人 应定义系列、类型、主题、类别、星级和受控术语的公共过滤器。

要求数据与发布负责人

GTA-DATA-004-R007 — 搜索

数据与发布负责人 应索引正式英文文本、标识符、标题、标题和批准的同义词。

要求数据与发布负责人

GTA-DATA-004-R008 — 分页和排序

数据与发布负责人 应提供确定性的结果顺序、游标和集合标识。

要求数据与发布负责人

GTA-DATA-004-R009 — 错误模型

数据与发布负责人 应返回稳定的代码和安全的消息,而不会受到限制的披露。

要求数据与发布负责人

GTA-DATA-004-R010 — 版本和缓存

数据与发布负责人 应识别内容版本、完整性、替换和失效语义。

要求数据与发布负责人

GTA-DATA-004-R011 — 辅助功能字段

数据与发布负责人 应提供标签、替代文本、标题结构和表格关系。

要求数据与发布负责人

GTA-DATA-004-R012 — 导出包

数据与发布负责人 应提供带有完整性检查的 Markdown、结构化、打印和引文表示形式。

禁止

5 接口资源模型

公共接口可以被实现为静态资源、应用程序接口或两者。实现形式不应改变资源标识、授权内容、固定版本不变性或活动表示和版本特定表示之间的区别。

资源逻辑路线或包裹位置所需代表公共统治
系统清单/manifest 或 manifest.json系统标识、版本、状态、权限、文档清单和资源链接仅列出授权的公共文件和公共预测
活动文档的值 canonical_path 或 documents/<document-id>.json活动版本的完整已验证文档对象只能通过授权发布进行更改
固定版本文档的值 fixed_version_path 或 versions/<document-id>/<version>.json不可变的经过验证的文档对象永远不会解析为不同的内容完整性值
搜索集合/search 或 search-index.json具有稳定目的地的文档和需求搜索记录排除受限文本和隐藏标识符
术语/terms 或 terms.json受控术语标识符、首选术语和定义仅限正式英文
公共政策/policy 或 policy.json列入许可名单的公共政策根源不包括内部控制和受限的安全参数
人际关系/relationships 或 relationships.json两个端点都是公共的关系不能从省略的边推断出隐藏端点
可追溯性/traceability 或 traceability.json要求到公众实施的路线数组仅包含公共文档身份
模式/schemas/<schema-name> 或 schemas/<schema-name>.json主动验证合约暴露模式身份和完整性
授权获奖结果/awards/<result-id> 或受控结果导出授权产品范围、星级、星级短语、最终评语、可选出版索引、标记状态和验证参考仅在结果和发布授权后存在
许可

6 获奖结果表述

领域基数释放条件
result_id正好一个稳定的公共安全结果身份
product_name正好一个等于授权市场身份
product_scope正好一个确定评审版本、格式、制剂和市场范围,但不披露限制性配方数据
public_primary_category_id正好一个解析为授权的公共主要类别
product_type_id正好一个在授权的公共主要类别内解决
star_level正好一个为零、一、二或三;零表示没有奖项,而不是星级
star_phrase有条件的需要一颗星、两颗星或三颗星,并且等于受控公共短语
final_comment正好一个有证据支持、特定于产品并授权发布
publication_index可选的被明确标记为非规范且从未用于得出星级
mark_state正好一个说明商标的使用是否根据单独的条款被授权、暂停、过期或撤销
verification_reference正好一个解析为公共验证记录,而不暴露盲映射或评审员身份
content_hash正好一个保护完整发布的结果表示

公共结果字段不得包含盲码、样本保管详细信息、评审员标识符、原始响应、个人观察、冲突声明、专业确认投票、内部原因代码、非公开结果或未发布的审查证据。

禁止

7 检索、过滤和排序

资源请求应通过稳定身份来解决。仅当该属性是公共的时,集合可以按文档族、文档类型、主题、类别、授权星级或受控术语进行过滤。除非接口明确标识另一个操作符,否则过滤器应是连接的。不支持的过滤器将返回错误;不应该被默默地忽视。

默认文档排序应遵循受控登记册。需求搜索结果应使用具有稳定身份的确定性相关性排序作为最终的决胜局。星级结果集合应使用显式声明的确定性顺序和不透明的连续游标。游标应绑定到集合标识、过滤器集、排序规则和表示的版本,以便以后的版本不能默默地更改正在进行的遍历。

搜索应索引正式的英文标题、标题、要求标识符、授权发布的正文、首选受控术语和批准的检索同义词。同义词可以改善发现,但不得取代显示结果或引用文本中的受控术语。

禁止

8 响应、错误、缓存和完整性规则

成功的结构化响应应识别资源、表示版本、可见性、内容完整性值和规范关系。收集响应还应识别所应用的过滤器、确定性顺序、已知的结果计数以及适用的连续状态。

错误代码含义所需的安全响应
GTA-IF-400格式错误的身份、过滤器、游标或表示请求识别无效的公共参数而不回显受限输入
GTA-IF-403经过身份验证的请求者缺乏对非公共资源的权限既不透露限制的内容也不透露限制的原因
GTA-IF-404没有公共资源解析所请求的身份无论身份不存在还是非公开,都返回相同的公共响应
GTA-IF-409请求的表示与资源状态或版本冲突识别公共状态冲突和存在的规范公共路线
GTA-IF-422请求在语法上有效,但违反了受控查询规则识别违反的公共规则
GTA-IF-500完整性、投影或发布验证失败抑制受影响的表示并发出公共安全故障参考

活动资源可以在授权发布后重新生效。固定版本资源应使用不可变缓存,并应保留相同的内容完整性值。撤销的活动路由不会删除其固定版本记录;对该记录的访问应遵循授权状态和可见性规则。

要求

9 导出和引用包

文件导出应标识受控文件编号、正式标题、版本、状态、语言、固定版本路径、条款锚点和内容完整性值。 Markdown、结构化数据、阅读器 HTML、打印和引文表示应从同一授权对象生成,并应保留需求标识、规范语言、表格、注释和关系目的地。

引文应解析为文件或稳定条款锚。对活动路线的引用应显示所代表的版本。旨在支持持久主张的引文应使用固定版本途径。导出包应包含足以验证每个包含的资源属于同一授权版本的清单和完整性值。

可访问性元数据是表示合同的一部分。阅读器和导出输出应保留标题顺序、表格标题关系、描述性标签、替代文本、键盘可操作目标以及任何非文本内容的等效文本。

要求

10 合规性和记录

符合 公共接口和导出格式规范 需要证据,包括模式结果、对象标识、关系检查、权限事件和重建测试。每个适用的记录 GTA-DATA-004 要求应允许在不依赖未记录的解释的情况下进行重建。

根据以下内容创建的证据 GTA-DATA-004 应使用稳定的标识符、不可变的事件序列号和机器事件时间戳。更正只能是追加的。不符合项应将受影响的对象置于不可释放状态,直到记录其后果和授权处置。角色组合仍须遵守强制分离规则。