Bridgeconn / usfm-grammar

An elegant USFM parser.
https://usfmgrammar.vachanengine.org/
MIT License
36 stars 14 forks source link

JSON Schema for 3.x #180

Closed kavitharaju closed 1 year ago

kavitharaju commented 1 year ago

Once the JSON output schema is validated and finalized after enough manual tests in the python module, need to define a schema, which can be used for automated testing for further developments in js or other modules.

Also documentations about how it is different from 2.x would be good to have.

kavitharaju commented 1 year ago

Might come useful https://github.com/coveooss/json-schema-for-humans

kavitharaju commented 1 year ago

here is some output samples of current v3 JSON. Sharing for discussion and finalizing output structure.

kavitharaju commented 1 year ago

We could support two JSON schemas.

kavitharaju commented 1 year ago

JSON_refactor.md

@joelthe1 How does these JSON outputs look? Sharing for review.

joelthe1 commented 1 year ago

This is done within the scope described. High-level schema defined for the newly proposed USJ format.