Add warnings array to JSON error responses - #278
Merged
Conversation
Include a warnings array in JSON error responses so the schema has a stable place for future machine-actionable warnings. Add shared JSON operation output/result types for future consolidation of command-specific JSON payloads, and document the stdout/stderr contract.
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
1 participant
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
warningsfield (always[]for now) tojsonErrorResponseto reserve the schema for future machine-actionable warningsjsonOperationOutput/jsonOperationResulttypes for future consolidation of per-command JSON output structsnullnever appears in JSON output (always[]or{})warningsfield in error responsesTest plan
warningsis always an empty array (not null) in error responsesnewJSONOperationOutputnormalizes nil inputs/results/warningsgofmt,go vet,golangci-lintclean