JSON Schema — стандарт .meb
Статус:
[x]готово — версия 3.0.0
Формальная схема валидации файла .meb, соответствующая стандарту JSON Schema Draft 2020-12.
Файлы
meb.schema.json— схема файла.mebв текущей версии (3.0.0){версия}/meb.schema.json— схемы отдельных версий:1.0.0,1.1.0,1.2.0,2.0.0,2.1.0,2.2.0,2.3.0,2.4.0,2.5.0,2.6.0,3.0.0
Что проверяет схема
- Обязательные поля на каждом уровне вложенности
- Примитивные типы (
string,number,boolean,array,object) - Перечислимые значения (enums) — все поля с заранее определённым списком значений
- Числовые диапазоны — размеры (
> 0), углы, количества, порядок нанесения - Условные поля — например,
drilling.faceобязательно, когдаtype: "face",material.sheetобязательно, когдаcategory: "board" - Формат
meta.version(semver) иmeta.checksum(sha256) - Расширения вендоров — поля
x_*допускаются везде, остальные неизвестные поля отклоняются
Чего схема не проверяет
Схема структурная — она не может проверять зависимости между списками. Приведённые ниже правила требуют валидации на стороне приложения:
| Правило | Где описано |
|---|---|
Целостность ссылок — каждое *_ref должно указывать на существующий id | spec §15.2 |
Уникальность id в пределах коллекции | spec §15.1 |
| Петли граней многогранника: соседние вершины соединены ребром, грань плоская, отверстия внутри контура | spec §15.9 |
| Панель принадлежит не более чем одной группе совпадения текстуры | spec §15.4 |
| Панели в группе совпадения текстуры используют один и тот же материал | spec §15.4 |
Ряды группы совпадения текстуры (row) образуют непрерывную последовательность 1…n, а позиции в ряду (order) — 1…m без повторений | spec §15.4 |
| Панели ряда группы совпадения текстуры имеют одинаковый размер вдоль текстуры | spec §15.4 |
| Панель помещается в размеры листа материала | spec §15.5 |
| Блок группы совпадения текстуры помещается на листе вдоль и поперёк текстуры | spec §15.4 |
edging.sequence ∈ {width_first, length_first} | spec §8.5 |
Край не имеет одновременно edging и edge_finish | spec §15.8 |
Стенка не встречается одновременно в edging.walls и edge_finish.walls | spec §15.8 |
2 × edge_finish.chamfer < dimensions.thickness | spec §15.8 |
Уникальность hardware_instance.id и id тел шкафов | spec §15.1 |
Отверстия extrusion внутри контура и без взаимных пересечений | spec §15.9 |
Длина positions и triangles кратна 3, индексы в пределах сетки | spec §15.9 |
hardware_instance_ref указывает на единицу фурнитуры с позицией | spec §15.9 |
Как использовать
Валидация (CLI)
bash
# ajv-cli (Node.js)
npm install -g ajv-cli
ajv validate -s schema/meb.schema.json -d plik.meb
# jsonschema (Python)
pip install jsonschema
jsonschema -i plik.meb schema/meb.schema.jsonВалидация в PHP
php
composer require opis/json-schema
$validator = new \Opis\JsonSchema\Validator();
$schema = \Opis\JsonSchema\Schema::fromJsonString(
file_get_contents('schema/meb.schema.json')
);
$result = $validator->validate(
json_decode(file_get_contents('plik.meb')),
$schema
);Автодополнение в VSCode
Добавьте в .vscode/settings.json:
json
{
"json.schemas": [
{
"fileMatch": ["*.meb"],
"url": "./schema/meb.schema.json"
}
]
}Версионирование схемы
Схема версионируется вместе со стандартом. Поле $id содержит версию:
https://meb.org.pl/schema/3.0.0/meb.schema.jsonПри каждом изменении MINOR или MAJOR стандарта публикуется новая версия схемы по новому URL.