Skip to content

docs(triage-engine): document building and changing rules with the API - #16975

Open
paulOsinski wants to merge 1 commit into
DefectDojo:devfrom
paulOsinski:docs/triage-engine-rules-api
Open

paulOsinski wants to merge 1 commit into
DefectDojo:devfrom
paulOsinski:docs/triage-engine-rules-api

Conversation

@paulOsinski

Copy link
Copy Markdown
Contributor

Description

Docs for driving Triage Engine rules from scripts. The rules resource has been on the public, token-authenticated API at /api/v2/rules_engine_v2/rules/ for a while, but the docs covered only its sharing, export, import and version routes. Nothing explained how to create a rule, what a graph looks like on the wire, or how to change one safely.

This adds one page and one link:

  • automation/triage_engine/rules_api.md (new), "Building Rules with the API": the endpoints, the writable and read-only fields of a rule, the graph format (nodes, edges, sourceHandle on multi-output nodes, the rules a graph must pass), and a worked example that validates, previews, creates, runs and enables a rule with curl and jq. It also covers changing a rule (whole-graph replacement, masked secrets sent back as-is, last write wins, receiver-managed rules and detach, take ownership), inline schedules, starting from a template, deleting, and the response codes.
  • automation/triage_engine/sharing_and_versions.md: one sentence in "Using the API" pointing to the new page.

Test results

Docs only: English .md files, no code. Language copies are generated by the translation workflow.

  • hugo --minify --gc --config config/production/hugo.toml builds clean, as in validate_docs_build.yml.
  • Every relative link and anchor on the new page resolves in the built site.
  • Each example request (validate, preview, create, partial update of the graph, mode and enabled, templates, delete, the schedule-required refusal, an unconnected node, a misspelled scope filter) was run against a local instance, and the documented status codes and response shapes match what it returned.

Documentation

This PR is the documentation change.

🤖 Generated with Claude Code

Adds a page covering the /api/v2/rules_engine_v2/rules/ endpoints for
creating, validating, previewing, changing, scheduling, running and
deleting rules, with the graph format and worked curl examples. Links
it from the existing API section in Sharing and Versions.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@paulOsinski paulOsinski added this to the 3.5.300 milestone Nov 17, 2026
@github-actions github-actions Bot added the docs label Nov 17, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant