sourcegraph/schema/README.md

Sourcegraph JSON Schemas

JSON Schema is a way to define the structure of a JSON document. It enables typechecking and code intelligence on JSON documents.

Sourcegraph uses the following JSON Schemas:

• settings.schema.json
• critical.schema.json
• site.schema.json

Modifying a schema

1. Edit the *.schema.json file in this directory.
2. Run bazel run //schema:write_generated_schema.
3. Commit the changes to both files.
4. Run sg start to automatically update TypeScript schema files.

Known issues

• The JSON Schema IDs (URIs) are of the form https://sourcegraph.com/v1/*.schema.json#, but these are not actually valid URLs. This means you generally need to supply them to JSON Schema validation libraries manually instead of having the validator fetch the schema from the web.