docs: add Xquik example and redact startup secrets - #15
Conversation
|
Updated the branch with commit The PR now includes an independent security repair: startup no longer logs the resolved API key, the full configuration containing a direct key, or raw custom request headers. The new redacted summary keeps operationally useful counts and non-secret fields, with tests covering direct and environment-based key configuration. The Xquik example also carries the required independent-service disclosure. The full Go suite, race detector, vet, module tidiness, diff checks, and live OpenAPI tag verification pass. |
Signed-off-by: Burak <8755484+kriptoburak@users.noreply.github.com>
2bf9f88 to
52001d4
Compare
|
Published signed repair commit The security fix now also redacts userinfo and query tokens from authenticated spec URLs. Parser errors no longer include non-200 response bodies. The new regression covers URL credentials, query tokens, and response secrets. Fresh validation on the exact head:
The PR is mergeable. GitHub CI still requires maintainer approval before any job can run. |
Signed-off-by: Burak <8755484+kriptoburak@users.noreply.github.com>
52001d4 to
9808c8d
Compare
Summary
https://xquik.com/openapi.jsonXQUIK_API_KEYto the nativex-api-keyheader flagsTweetsandTrendstag filtersXquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.
Repository Fix
Startup previously logged the full configuration, resolved API key, and raw
REQUEST_HEADERSvalue. Authenticated specification URLs and non-200 response bodies could also expose credentials. The revised summaries retain useful non-secret metadata. Parser logs and errors remove URL userinfo and queries. Tests cover direct keys, environment keys, custom headers, spec credentials, query tokens, and response secrets.Validation
go mod tidywith no module diffgo test ./...go test -race ./...go vet ./...go build ./...git diff --checkTweetsandTrendsNo repository license file or detected license metadata was found. This contribution adds no vendored code or generated assets.