JSON Schema — standard .meb
Status:
[x]gotowe — wersja 3.0.0
Formalny schemat walidacji pliku .meb zgodny ze standardem JSON Schema Draft 2020-12.
Pliki
meb.schema.json— schemat pliku.mebw bieżącej wersji (3.0.0){wersja}/meb.schema.json— schematy poszczególnych wersji: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
Co schema waliduje
- Wymagane pola na każdym poziomie zagnieżdżenia
- Typy prymitywne (
string,number,boolean,array,object) - Wartości wyliczeniowe (enums) — wszystkie pola z predefiniowaną listą wartości
- Zakresy liczbowe — wymiary (
> 0), kąty, ilości, kolejność nakładania - Pola warunkowe — np.
drilling.facewymagane gdytype: "face",material.sheetwymagane gdycategory: "board" - Format
meta.version(semver) imeta.checksum(sha256) - Rozszerzenia vendorów — pola
x_*dozwolone wszędzie, pozostałe nieznane pola odrzucane
Czego schema nie waliduje
Schema jest strukturalna — nie może weryfikować zależności między listami. Poniższe reguły wymagają walidacji po stronie aplikacji:
| Reguła | Gdzie opisana |
|---|---|
Integralność referencji — każde *_ref musi wskazywać na istniejące id | spec §15.2 |
Unikalność id w obrębie kolekcji | spec §15.1 |
| Pętle lic wielościanu: kolejne wierzchołki połączone krawędzią, lico płaskie, otwory wewnątrz obrysu | spec §15.9 |
| Formatka należy do co najwyżej jednej grupy słoja | spec §15.4 |
| Formatki w grupie słoja używają tego samego materiału | spec §15.4 |
Rzędy grupy słoja (row) tworzą ciągłą sekwencję 1…n, a pozycje w rzędzie (order) — 1…m bez powtórzeń | spec §15.4 |
| Formatki rzędu grupy słoja mają ten sam wymiar wzdłuż słoja | spec §15.4 |
| Formatka mieści się w wymiarach arkusza materiału | spec §15.5 |
| Blok grupy słoja mieści się w arkuszu wzdłuż i w poprzek słoja | spec §15.4 |
edging.sequence ∈ {width_first, length_first} | spec §8.5 |
Krawędź nie ma jednocześnie edging i edge_finish | spec §15.8 |
Ścianka nie występuje jednocześnie w edging.walls i edge_finish.walls | spec §15.8 |
2 × edge_finish.chamfer < dimensions.thickness | spec §15.8 |
Unikalność hardware_instance.id i id brył szafek | spec §15.1 |
Otwory extrusion wewnątrz konturu i bez wzajemnych przecięć | spec §15.9 |
Długość positions i triangles wielokrotnością 3, indeksy w zakresie siatki | spec §15.9 |
hardware_instance_ref wskazuje akcesorium z pozycją | spec §15.9 |
Jak używać
Walidacja (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.jsonWalidacja w 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
);Autouzupełnianie w VSCode
Dodaj do .vscode/settings.json:
json
{
"json.schemas": [
{
"fileMatch": ["*.meb"],
"url": "./schema/meb.schema.json"
}
]
}Wersjonowanie schematu
Schema jest wersjonowana razem ze standardem. Pole $id zawiera wersję:
https://meb.org.pl/schema/3.0.0/meb.schema.jsonPrzy każdej zmianie MINOR lub MAJOR standardu publikowana jest nowa wersja schematu pod nowym URL.