Generate commands.schema.json for per-command success validation#311
Merged
Conversation
Adds a JSON Schema 2020-12 file generated from commands.json that validates command-specific success responses: envelope fields, result status/kind enums, warning codes, and field sets. CI verifies the schema stays in sync via gen-json-schemas, and tests validate all golden outputs against it.
2f4c6ee to
2fb60b3
Compare
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.
Summary
docs/json-schema/v1/commands.schema.json(JSON Schema 2020-12) fromcommands.json— validates per-command success responses including envelope fields, result status/kind enums, warning codes, and field setsinternal/jsonschemapackage withGenerateCommandSuccessSchemafor deterministic schema generationtools/gen-json-schemastool with CI drift detectionschema_refs.command_success_schemato each manifest pointing to the per-command definitionTest plan
go test ./...passesgolangci-lint run ./...cleangofmt -s -l .cleanTestPublicJSONCommandSuccessSchemaMatchesGeneratedCatalog— drift detectionTestGoldenSuccessOutputsValidateAgainstPublicCommandSuccessSchema— validates all golden outputsTestPublicCommandSuccessSchemaRejectsInvalidStatus— verifies schema catches invalid datagen-json-schemasand checks for drift