What the $ref - Create composable JSON Schemas

Lightning talk 8th Feb 2022

Transcript

1. What the $ref Create composable JSON Schemas Lightning Talk, Niklas
2. JSON Schema https://json-schema.org/ 2
3. JSON Schema Also, refer to my past Lightning Talk about JSON Schema validation: Slides 3
4. JSON Schema 4
5. Element Templates JSON Schema 5
6. Element Templates JSON Schema 6
7. New: C8 Element Templates 7
8. Problem(s) First contribution - hard to comprehend what’s going on Extending is (quite) impossible Don’t repeat yourself 8
9. Problem(s) First contribution - hard to comprehend what’s going on Extending is (quite) impossible Don’t repeat yourself Goal: Make JSON Schema composable 9
10. $ref property https://json-schema.org/un derstanding-json-schema/st ructuring.html 10
11. $ref property 11
12. $ref property What’s the problem here? 12
13. $ref property https://json-schema.org/un derstanding-json-schema/st ructuring.html 13
14. $ref property https://json-schema.org/un derstanding-json-schema/st ructuring.html 14
15. $ref property https://ajv.js.org/guide/combining -schemas.html 15
16. $ref property 16
17. JSON Schema was not built with inheritance in mind (json-schema-org/json-schema-spec#348) $ref property 17
18. Solution: json-schema-ref-parser 18
19. Composable JSON Schema (sketch) 19
20. Composable JSON Schema (sketch) Definitions base-properties cloud-properties platform-properties base groups scopes Product Export 20
21. Composable JSON Schema (sketch) platform.json Definitions base-properties cloud-properties platform-properties base groups scopes Product Export 21
22. Composable JSON Schema (sketch) platform.json Definitions base-properties cloud-properties platform-properties base groups scopes Product Export schema.json 22
23. Composable JSON Schema (sketch) platform.json cloud.json Definitions base-properties cloud-properties platform-properties base groups scopes Product Export schema.json 23
24. Composable JSON Schema (sketch) platform.json cloud.json Definitions base-properties cloud-properties platform-properties base groups scopes Product Export schema.json cloud.json 24
25. Composable JSON Schema (sketch) platform.json cloud.json Definitions base-properties cloud-properties platform-properties base groups scopes Product Export schema.json cloud.json Backwards compatibility 25
26. <Demo /> 26
27. Summary • Check it out: https://github.com/camunda/element-templates-json-schema/pull/41 • No breaking changes, exported schema kept almost the same • Platform and Cloud have own schema definitions now • Base definitions can be handled separately, composed later • We don’t have to bother with the single, huge schema file • Tests are green, only schemaPath updates needed 27
28. Thank you! 28