docs(vuln): align Vulnerability Reporting doc with shipped code#224
Merged
maximelb merged 1 commit intoMay 13, 2026
Conversation
Removes claims that don't match the extension as it ships: - `sla_windows_hours` config field (doesn't exist in Configuration struct) - `vuln_finding.sla_breach_warning` event (never emitted; no SLA-breach scan in the daily tick) - `vuln_finding.resolution_changed` event (real name is `vuln_finding.state_changed`) - Lifecycle "Counts against SLA" column (no SLA enforcement in code) - Daily tick described as four scans (it's three) with 60s timeout (it's 10 minutes — `scanLongRunningTimeout`) Adds documentation for capabilities the doc had previously omitted: - `vuln_finding.closed` event (fired by org-scope fingerprint reconciliation and by `reset_asset_findings`) - `reset_asset_findings` action (used for reformat / reimage / decommission of a host) Replaces the SLA-configuration best-practices section with guidance on how to track remediation cadence externally given that the extension does not enforce SLAs natively. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
f2d02ae
into
vuln-uplift/asset-tags-and-extension-docs
1 of 2 checks passed
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
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
Audited
docs/5-integrations/extensions/limacharlie/vulnerability-reporting.mdagainst the actualext-vulnerability-reporting/ext/source. Found six things wrong or missing — this PR fixes them. Stacked on top ofvuln-uplift/asset-tags-and-extension-docs(#223) since that's where the doc lives.Wrong claims removed
sla_windows_hoursconfig field — doc described it as a top-level config knob with defaults and a JSON example. TheConfigurationstruct (extension.go:87-99) has onlyscan_modeandcriticality_tag_overrides;configSchema()confirms only those two are exposed. Removed from the config table, JSON example, validation paragraph, and the SLA-configuration best-practices section.vuln_finding.sla_breach_warningevent — never emitted anywhere in code; nosla_breachscan exists in the daily tick. Removed from the events table, the workflow text, the Outputs-integration list, and the glossary.vuln_finding.resolution_changedevent name — the actual constant isvuln_finding.state_changed(events.go:18). Renamed everywhere.scans.go:97-105runs three scans (kev_match,daily_snapshot,epss_history) withscanLongRunningTimeout = 10 * time.Minute. Updated the tick description, the table, and the glossary.lc:asset:criticality:*the SLA-window source — only the LC Risk multiplier remains.Capabilities now documented
vuln_finding.closedevent (events.go:16/events.go:185) — fires when the last sensor holding(cve, normalized_package_name)clears it on a rescan, and per cleared fingerprint whenreset_asset_findingswipes a host. Added to the events table.reset_asset_findingsaction (extension.go:812,reset_findings.go) — wipes every finding owned by(oid, sid). Added to the API actions table and given a reference subsection with request, response, and side-effect notes.Replacement guidance
The deleted "SLA configuration" section is replaced with a "Tracking remediation deadlines" section explaining that the extension does not enforce a built-in SLA and pointing operators at the available signals (
vuln_finding.created,first_seen_at,vuln_finding.closed, mitigatedstate_changed) for wiring deadlines in their downstream ticketing system.Test plan
created,closed,kev_match,state_changed).sla_breach,resolution_changed, andsla_windows_hours— should be zero hits.🤖 Generated with Claude Code