Add JSON schema envelope and normalize all output fields#289
Merged
Conversation
Stamp ok, schema_version, and command on JSON success and error envelopes. Normalize operation results so status, kind, input, and result are always present, with explicit statuses for account, du, version, rm, cp, and mv. Publish top-level JSON schema files, validate schema/error-code drift in contract tests, forbid unknown result statuses in command schemas, and document partial-success behavior for recursive and multi-target commands.
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
ok,schema_version, andcommandfields to every JSON response (success and error)omitemptyfrom operation result fields —status/kinddefault to"unknown",input/resultdefault to{}found), du (reported), version (reported), rm (deleted/permanently_deleted), cp (copied), mv (moved)docs/json-schema/v1/with contract tests validating themTest plan
TestPublicJSONSchemaFilesvalidates schema files match code (required fields, properties, const values, error code enum)TestStructuredOutputGoldenSchemaAuditvalidates updated schemas with new envelope fields and explicit statusesTestStructuredOutputGoldenSuccessOutputAuditvalidates updated golden examples with envelopeTestRenderCommandErrorWritesJSONErrorToStdoutverifiesschema_versionandcommandon errorsTestRenderJSONOperationOutputverifiesok/schema_version/commandon successTestNewJSONOperationResultNormalizesEmptyFieldsverifies unknown defaultsassertGoldenCommandStatusesensures no command has empty or "unknown" status listgofmt,go vet,golangci-lintall pass