README

“Автокод”项目公共规格

本存储库包含与“Автокод”项目相关的公共规格。

数据报告字段

数据字段（以下简称为“字段”）具有以下属性

字段具有唯一的路径 (path);
字段的路径 (path) 是固定的；
字段名称由小写拉丁字母组成；
如果需要将字段名称拆分为复合词，则使用下划线符号 (_)；
使用点 (.) 符号进行字段分组；
注释的深度可以是任意的；
为了指示字段路径的元素是数组，使用表示 [] (添加到字段组的末尾)。
为了指示字段可以包含的数据类型，可以使用以下关键字 - array、boolean、float、integer、object、string、null；
每个字段都可以是 null。

点符号注释示例

存在一组字段：name、year、vin、owner_name。所有这些都与汽车的基木特性有关，除了 owner_name，它属于所有者数据。在这种情况下，它们的命名将如下所示： base.name、base.year、base.vin、owner.owner_name。

数组指针使用示例

报告包含有关车辆技术检查日期和地点的数据集。这些数据字段的类型分别是 diagnostic_card.items[].date 和 diagnostic_card.items[].place。这意味着 diagnostic_card.items[] 是一个数组，其元素具有 date 和 place 键。

所有字段的描述 可以在此文件中找到，json-schema 报告位于 此文件。

报告示例：带有数据的示例，无数据的示例。

标识符类型

要创建报告，需要传递标识符的类型和值（VIN 码、牌照号等）。

支持标识符类型及其描述列在此文件中。

源名称

为了生成报告数据，会向不同的源进行调用。每个源都具有以下属性

源名称由小写拉丁字母组成；
使用点 (.) 符号进行源分组；
每个源填充固定的一组字段；
如果多个源填充相同的字段，则报告包含我们认为最可信的源的数据。

您可以在此文件中了解我们支持的所有源。

品牌和车型标识符

报告可能包含有关品牌和车型以及它们的唯一标识符（由字母 A-Z、数字和下划线 _ 组成）的数据。

您可以在以下文件中了解我们支持的识别符：品牌和型号。

型号按车型类别划分。例如：models_bus.json - 巴士。

您可以在以下规格文件中了解型号类型的标识符。

更新和版本控制

该仓库中的数据会随着时间的推移进行更新。变更状态通过使用标签并指定相应的版本号来固定。版本号按照语义化版本控制规则分配。

目前存在3个主版本

v1 - 已过时（自2018年6月22日起不再支持）;
v2 - 已过时（自2019年2月19日起不再支持）;
v3 - 当前有效。

为了接收变更通知，请通过 此链接 进行订阅。

SDK

提供以下 SDK 以方便访问这些规格数据

PHP avtocod/specs-php

支持

如果您在使用该仓库时遇到任何问题，请创建相应的 issue，通过此链接。

avtocod / specs

维护者

详细信息