Vervangen Json schema generator conform "encoding rules"

[ArjanLoeffen]

Geonovum neemt initiatief tot encoding rules voor Json schema. Deze regels moeten ook op MIM modellen in imvertor worden toegepast. Dat betekent dat de huidige schema's en aanpak in Imvertor moet worden aangepast om de voldoen aan de nieuwe eisen.

De encoding rules:

• Norm: Best Practice for OGC - UML to JSON Encoding Rules
• De norm wordt geïmplementeerd in Shapechange. Zie ook issues rondom het evalueren van de norm in ShapeChange

[ArjanLoeffen]

Json schema's komen op twee plekken terug in Imvertor resultaten.

• Als los Json schema (en yaml voor de liefhebber) met optie createjsonschema (de "Kadaster" methode). Zie voorbeelden
  Fietsenwinkel.zip (voorbeeld uit Primer) en IMVB.ZIP (testmodel met alle constructs)
• Als yaml schema als onderdeel van de OAS3 generatie van BSM modellen zoals gebouwd door VNG (de "VNG" methode). Voorbeeld bestanden nog toevoegen @melsk-r . Een vergelijking van de Kadaster en VNG methodes staat hier: Vergelijking van generatiemethodes.xlsx

Ter vergelijking: ShapeChange resultaten voor de voorbeeld modellen zijn hier: Shapechange.zip. Een vergelijking van dit formaat met de Kadaster methode staat hier: SC-IMV-analyse.docx. ShapeChange test repository issues vind je hier.

Op dit moment wordt Json schema via EP gegenereerd. Dus Imvertor-XML naar EP naar Json-schema (naar yaml schema). Dit geldt voor beide methoden. Maar de implementaties lopen uiteen.

• De EP formaten wijken af.
• De json formaten wijken af.
• Aanname is dat de yaml formaten niet afwijken als de json formaten gelijk zijn; yaml wordt gegenereerd vanuit Json op basis van een publieke java library.

De strategie om te komen tot één module die de EP genereert (dus één variant, zie #337) en van daaruit één Json schema variant, moet serieus worden bekeken. VNG geeft aan dat het vooralsnog niet mogelijk is om af te wijken in de json/yaml schemas zoals die nu in OAS worden samengesteld. Dit, omdat afnemers aanpassingen niet zullen volgen.

Vooralsnog zal dus EP moeten worden gelijkgetrokken waarna (als nodig) de bedoelde twee json schema varianten worden opgeleverd. Dat is alvast het halve werk.

Ook zal dit EP formaat worden gegenereerd vanuit een MIM serialisatie. Dat is afwijkend van de huidige aanpak, waarbij het vanuit Imvert-XML wordt samengesteld (in beide methoden). Dit betekent dat de Json schema module alléén bedoeld is voor MIM modellen. Daarbij moet dus VNG kijken of die aansluiting (in BSM context) wel werkt.

Voorwaardelijk voor een succesvolle implementatie is dus:

• Correcte en complete MIM serialisatie. De MIM serialisatie schema's zijn hier te vinden.
• Correcte EP serialisatie. EP formaat (het "EP schema") moet geaccepteerd worden door beide methoden. Het EP schema is hier te vinden.
• Correcte Json serialisatie, inclusief aansluiting op GeoJSon

NB

• issue waarin Kadaster EP wordt behandeld: Losse EP step ontwikkelen #56
• issue waarin Geometrie is opgenomen in Json schema: Generatie geometrie voor JSON en GeoJSON #219
• issue voor gelijk EP schema: EP formaat gelijktrekken tussen Kadaster en VNG implementaties #337

[melsk-r]

Bij deze de IMVB voorbeeld bestanden (json en yaml) gegenereerd m.b.v. de VNG-R methode BSM-IMVB.zip.

[ArjanLoeffen]

Inmiddels zijn beide genoemde schemas aangepast in een feature branch.

• De aangepast MIM 1.1.0 serialisatie schema's zijn in deze branch te vinden.
• Het EP schema is in deze branch te vinden.

Deze schemas kunnen dus nog worden aangepast obv voortgang in het werk.

[ArjanLoeffen]

De eerste oplevering is gedaan op 3 aug 2023. @lvdbrink loopt het resultaat door.

Zie https://github.com/Geonovum/shapeChangeTest/issues

[ArjanLoeffen]

Materiaal voor review van Johannes staat in

https://github.com/Geonovum/shapeChangeTest/tree/main/Results

[PalmJanssen]

Dit was een major succesvolle 👍 operatie in 2023.
JSON schema generatie is nu geintegreerd: JSON schema's (JSON, GeoJSON, JSON-FG).

Vraag: Is er ergens documentatie (voor de gebruiker) hierover.?

[ArjanLoeffen]

Nee, nog geen documentatie.