Document proxy support and refine JSON automation docs#336
Merged
Conversation
Add proxy configuration sections to README and automation docs covering HTTPS_PROXY/HTTP_PROXY/NO_PROXY for Dropbox API and OAuth exchange/refresh requests. Remove Cosign/SLSA/SBOM verification instructions and asset entries now that the release workflow only publishes SHA256SUMS. Clarify JSON envelope wording, the results[].result.auth path, warnings semantics, and when to use --output=json versus JSON help manifests.
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
README.mdanddocs/automation.mddocumentingHTTPS_PROXY/HTTP_PROXY/NO_PROXY(and lowercase forms) for both Dropbox API requests and OAuth token exchange/refresh. Includes shell, Windows PowerShell, cmd, and proxy-auth examples.README.md, since the release workflow now publishes onlySHA256SUMS(dropped in Fix Release workflow: drop disallowed SLSA provenance job #332 and Fix Release workflow: remove disallowed SBOM/Cosign actions #333).warningssemantics (machine-actionable warning objects), theresults[].result.authpath, and add a "Which interface should I use?" section distinguishing--output=jsonfrom JSON help manifests.actions/checkoutexample to@v7to match the workflows, and update the contributing PR link.Behavior verification
dbxclisetsClient: nilin its Dropbox config, so the SDK builds HTTP clients onhttp.DefaultTransport, which honorsProxyFromEnvironment. OAuth exchange/refresh use plain contexts on the same default transport. The documented proxy behavior therefore applies to both API and auth requests.Fixes #189 — the proxy documentation answers how to force dbxcli through a specific (e.g. local) proxy, including on Windows.