Include JSON schema in definition API

UUDigitalHumanitieslab / I-analyzer

The great textmining tool that obviates all others

https://ianalyzer.hum.uu.nl

MIT License

6 stars 2 forks source link

Include JSON schema in definition API #1588

Open lukavdplas opened 1 month ago

lukavdplas commented 1 month ago

We have a JSON schema for corpus definitions, but it can only be accessed through the source code.

Suggestions:

Include $schema property when exporting JSON definitions.
Allow the frontend to validate JSON uploads against the (current) schema.
Allow users to inspect the schema. (A URL to the JSON would be sufficient.)

supercoder-dev commented 6 hours ago

This PR improves our JSON definition handling by making the schema accessible outside the source code. We've added the schema to the exported JSON and included a URL for it in the API response. Now the frontend can validate uploads against the schema, and users can easily check it out. This should make working with corpus definitions much smoother for everyone.

https://github.com/UUDigitalHumanitieslab/I-analyzer/commit/3ccf0054142bd9bceba3e1c5cda279fbd4f59d3c