Add structured JSON error details#291
Merged
Merged
Conversation
Publish command catalog, eliminate unknown types, and harden schema
Add optional error.details to JSON error responses for stable machine-readable remediation context. Populate auth remediation fields, path conflicts, and Dropbox API summaries while omitting details for generic local failures. Document the optional details contract and extend schema/tests to keep it covered.
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
error.detailsobject to JSON error responses with machine-readable contextpathin details for path conflict errorstoken_type,login_command, andenv_varin details for auth errors (remediation info)api_summaryin details for Dropbox API errorsomitempty) when no structured context is availableTest plan
TestRenderCommandErrorIncludesCodedDetailsverifiesdetails.pathfor path conflictsTestRenderCommandErrorIncludesDropboxAPISummaryDetailsverifiesdetails.api_summaryfor SDK errorsTestJSONErrorDetailsIncludesAuthRemediationverifies auth remediation fieldsdetailsis omitted for generic errorsdetailsproperty exists in error schemagofmt,go vet,golangci-lintall pass