Skip to content

[FEATURE REQUEST] Provide a JSON schema for the export.json file #1007

Open
@sirephil

Description

@sirephil

Many JSON editors, such as VS Code, support validation and auto-completion for JSON files using JSON schemas.

It would massively simplify creation of the export.json configuration file if a schema was to be made available. This would also allow the documentation to be surfaced "live" within the JSON editor in use, meaning less context switching between the JSON editing and reading documentation.

Including a year/month part in the schema URI helps when you need to include changes to the schema because of the addition of new features.

Using JSON Schema Draft 7 provides widest compatibility for tooling, in my experience.

Metadata

Metadata

Assignees

Labels

feature-requestNew feature request or a change in the existing functionalityin-progressIssue is currently in the resolution progress

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions