avtocod / specs
Specifications repository
Installs: 42 313
Dependents: 1
Suggesters: 4
Security: 0
Stars: 6
Watchers: 8
Forks: 18
Open Issues: 3
Language:TypeScript
Suggests
- avtocod/specs-php: SDK for a working with specifications data.
- dev-master
- v3.160.0
- v3.159.0
- v3.158.0
- v3.157.0
- v3.156.0
- v3.155.0
- v3.154.0
- v3.153.0
- v3.152.0
- v3.151.1
- v3.151.0
- v3.150.0
- v3.149.0
- v3.148.0
- v3.147.0
- v3.146.0
- v3.145.0
- v3.144.1
- v3.144.0
- v3.143.0
- v3.141.0
- v3.140.0
- v3.139.0
- v3.138.0
- v3.137.0
- v3.136.0
- v3.135.0
- v3.134.0
- v3.133.0
- v3.132.0
- v3.131.0
- v3.130.0
- v3.129.0
- v3.128.0
- v3.127.0
- v3.126.0
- v3.125.0
- v3.124.0
- v3.123.0
- v3.122.0
- v3.121.0
- v3.120.0
- v3.119.0
- v3.118.0
- v3.117.0
- v3.116.0
- v3.115.0
- v3.114.0
- v3.113.0
- v3.112.0
- v3.111.0
- v3.110.0
- v3.109.0
- v3.108.0
- v3.107.0
- v3.106.0
- v3.105.0
- v3.104.0
- v3.103.0
- v3.102.0
- v3.101.0
- v3.100.0
- v3.99.0
- v3.98.0
- v3.97.0
- v3.96.0
- v3.95.0
- v3.94.1
- v3.94.0
- v3.93.0
- v3.92.0
- v3.91.0
- v3.90.0
- v3.89.0
- v3.88.0
- v3.87.0
- v3.86.0
- v3.85.0
- v3.84.0
- v3.83.0
- v3.82.0
- v3.81.1
- v3.81.0
- v3.80.0
- v3.79.0
- v3.78.0
- v3.77.0
- v3.76.0
- v3.75.0
- v3.74.0
- v3.73.0
- v3.72.0
- v3.71.0
- v3.70.0
- v3.69.0
- v3.68.0
- v3.67.0
- v3.66.0
- v3.65.0
- v3.64.0
- v3.63.0
- v3.62.0
- v3.61.0
- v3.60.1
- v3.60.0
- v3.59.0
- v3.58.0
- v3.57.0
- v3.56.0
- v3.55.0
- v3.54.0
- v3.53.0
- v3.52.0
- v3.51.0
- v3.50.0
- v3.49.0
- v3.48.0
- v3.47.0
- v3.46.0
- v3.45.0
- v3.44.0
- v3.43.0
- v3.42.0
- v3.41.1
- v3.41.0
- v3.40.1
- v3.40.0
- v3.39.0
- v3.38.0
- v3.37.0
- v3.36.0
- v3.35.0
- v3.34.0
- v3.33.0
- v3.32.0
- v3.31.0
- v3.30.0
- v3.29.0
- v3.28.0
- v3.27.0
- v3.26.1
- v3.26.0
- v3.25.1
- v3.25.0
- v3.24.0
- v3.23.1
- v3.23.0
- v3.22.0
- v3.21.0
- v3.20.0
- v3.19.0
- v3.18.0
- v3.17.0
- v3.16.0
- v3.15.1
- v3.15.0
- v3.14.0
- v3.13.0
- v3.12.0
- v3.11.0
- v3.10.1
- 3.10.0
- v3.9.0
- v3.8.0
- v3.7.0
- v3.6.0
- v3.5.0
- v3.4.0
- v3.3.1
- v3.3.0
- v3.2.0
- v3.1.0
- v3.0.0
- v2.x-dev
- v2.13.0
- v2.12.0
- v2.11.0
- v2.10.0
- v2.9.0
- v2.8.0
- v2.7.0
- v2.6.0
- v2.5.0
- v2.4.0
- v2.3.0
- v2.2.0
- v2.1.0
- v2.0.0
- v1.x-dev
- v1.2.2
- v1.2.1
- v1.2
- v1.1.2
- v1.1.1
- v1.1.0
- v1.0.1
- v1.0.0
- dev-add-secton-pledge-online
- dev-update-description-fields
This package is auto-updated.
Last update: 2024-11-05 06:40:21 UTC
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
- устаревшая (не поддерживается с 22 июня 2018 года);v2
- устаревшая (не поддерживается с 19 февраля 2019 года);v3
- актуальная.
Для того, что бы получать уведомления об изменениях - подпишитесь на них, перейдя по этой ссылке.
SDK
Список SDK
для удобного доступа к данным спецификациям:
Поддержка
Если у вас возникли какие-либо проблемы при работе с данным репозиторием, пожалуйста, создайте соответствующий issue
перейдя по данной ссылке.