Skip to content

docs: document On-Demand Scan API and new env vars (weekly audit) - #16

Merged
krakenhavoc merged 1 commit into
mainfrom
claude/modest-clarke-gFLNx
May 14, 2026
Merged

docs: document On-Demand Scan API and new env vars (weekly audit)#16
krakenhavoc merged 1 commit into
mainfrom
claude/modest-clarke-gFLNx

Conversation

@krakenhavoc

Copy link
Copy Markdown
Contributor

Weekly Documentation Audit — 2026-05-12

Documentation Gaps Addressed

The On-Demand Scan API was merged (PR #12) but README.md had no mention of the two new environment variables, the scan_api YAML config block, or the POST /scan endpoint.

Gap Fix
KK_PROBE_SCAN_API_ENABLED not in env var table Added with default false
KK_PROBE_SCAN_API_SECRET not in env var table Added with minimum 32-character requirement
scan_api YAML block missing from config reference Added with enabled and secret fields
POST /scan not mentioned in How It Works diagram Added conditional step to ASCII diagram
No On-Demand Scan API section Added section covering config, request format, response, and security guidance
No troubleshooting entry for secret length error Added entry with openssl rand -hex 32 example

Files Changed

  • README.md — env var table, YAML config block, new On-Demand Scan API section, How It Works diagram, troubleshooting section

Suggested Version Bump

The scan API was already merged in PR #12. If not yet tagged, release v0.2.0 — the on-demand scan endpoint is a new externally-facing feature, warranting a minor version bump per semver.


Generated by Claude Code

@krakenhavoc
krakenhavoc marked this pull request as ready for review May 14, 2026 14:36
@krakenhavoc
krakenhavoc merged commit ac57657 into main May 14, 2026
9 checks passed
@krakenhavoc
krakenhavoc deleted the claude/modest-clarke-gFLNx branch May 14, 2026 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant