feat: add JSON Schema export for config validation#4
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Generates and publishes a JSON Schema (
schema/config.schema.json) derived from theConfigInputTypeScript type, enabling config validation in non-TypeScript runtimes.Changes:
schema/config.schema.json— checked-in JSON Schema (draft-07) forConfigInput. Coversplans,PlanInput(features, extends, limits),Limit(quota:number | null, period enum), andPeriod.package.json— addsschema:generatescript usingts-json-schema-generator;ts-json-schema-generatoradded as devDependency.schema/already infilesfield from PR 1..github/workflows/ci.yml— adds "Check schema is up to date" step: regenerates the schema and fails the job with an explanatory message if the committed file differs from the generated output.Why
Implements v1 scope item 8. The JSON Schema lets non-TypeScript callers (Python services, CLI tools, config validators) validate a tiergraph config at runtime without shipping the TypeScript compiler. The CI drift check prevents the schema from silently going stale when types evolve.
How to verify
Out of scope