Add schema definition for the config

This commit is contained in:
Ben Jackson 2019-11-05 18:30:27 +00:00
commit 7297e12605
6 changed files with 656 additions and 0 deletions

19
docs/schema/index.md Normal file
View file

@ -0,0 +1,19 @@
# Vimsepctor JSON Schema
This area contains the [JSON Schema][json-schema] representation of the
configuration objects used for configuring Vimspector. For more information on
JSON Schema, check out [Understanding JSON
Schema](http://json-schema.org/understanding-json-schema)
Vimsepctor specification is based on [Draft 7][draft-7] of JSON Schema
standard.
# The schemas
* [`vimspector.schema.json`](vimspector.schema.json) - contains the full
configuration defnition (`.vimspector.json`).
* [`gadgets.schema.json`](gadgets.schema.json) - contains the specification for
gadget-only objects (`.gadgets.json`).
[json-schema]: http://json-schema.org
[draft-7]: https://json-schema.org/specification-links.html#draft-7