Skip to content

docs: [five-c] add usage and configuration documentation #416#557

Open
tdruez wants to merge 7 commits into
mainfrom
416-reference-documentation
Open

docs: [five-c] add usage and configuration documentation #416#557
tdruez wants to merge 7 commits into
mainfrom
416-reference-documentation

Conversation

@tdruez

@tdruez tdruez commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Issues

Policy Rules Reference Documentation

  • New reference page reference-policy-rules.rst documenting the Policy Rules Engine concept, built-in rules, configuration, and integrations
  • Built-in rules table split into policy-based and vulnerability-based categories, covering all eight rules with rule type, label, severity, and description
  • Violation lifecycle explaining the detected, active, resolved, and re-activated states
  • Configuration reference for the policy_rules_config JSON field with a full example and per-rule parameter details
  • Evaluation triggers documenting both automatic background re-evaluation and manual re-evaluation entry points
  • Webhook events documenting policy.violation_detected and policy.violation_resolved with payload descriptions, linked to the Webhook integration page
  • REST API documenting the GET /api/v2/products/{uuid}/policy_violations/ endpoint and all returned fields

tdruez added 7 commits July 24, 2026 10:18
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
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