Metaschema for Editor Convenience

apioo / typeschema

TypeSchema is a JSON format to describe data models in a language neutral format

https://typeschema.org/

MIT License

145 stars 3 forks source link

Metaschema for Editor Convenience #17

Closed DavidArchibald closed 6 months ago

DavidArchibald commented 7 months ago

It'd be nice to get autocompletion and documentation about the meaning of each of the fields in the schema itself, i.e. what options there are for type or so on. I'm able to associate my editors with a schema and I was hoping to do that for Typeschema.

Is there a metaschema already available for Typeschema? I struggled to find one and if so it should be better documented in my opinion.

chriskapp commented 7 months ago

Hi @DavidArchibald yes so TypeSchema itself is also described with a meta TypeSchema you can also export this TypeSchema specification as JsonSchema which most editors understand. Regarding the description of each type we can always improve the specification and make the wording more clear, so please let me know in case you have some suggestions.