Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JSON schema to SchemaStore #192

Open
GhostofGoes opened this issue Aug 14, 2024 · 1 comment
Open

Add JSON schema to SchemaStore #192

GhostofGoes opened this issue Aug 14, 2024 · 1 comment

Comments

@GhostofGoes
Copy link
Collaborator

Add JSON schemas for Topology, Scenario, Experiment, Image, and other schemas to SchemaStore. This would enable auto-completion and validation in editors such as VSCode, improving quality of life for developers.

The primry barrier to me simply opening a PR on SchemaStore is the fact the JSON schema is embedded in Go code and only generated in JSON form when doing a query to /api/v1/schemas/{version} (v1 or v2). To add it to SchemaStore, the file must be static committed into GitHub. There appears to be at least one schema file in the Builder directory, but I think it's out of date.

@activeshadow
Copy link
Collaborator

This seems like a good idea @GhostofGoes, and it should be possible to use Go's native file embed capabilities to facilitate having the schemas as static JSON files in the repo while still being embedded in the Go binary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants