Repository navigation
docs(triage-engine): document building and changing rules with the API - #16975
Open
paulOsinski wants to merge 1 commit into
Open
paulOsinski wants to merge 1 commit into
paulOsinski wants to merge 1 commit into
Conversation
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>
This branch has not been deployed
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.
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,sourceHandleon multi-output nodes, the rules a graph must pass), and a worked example that validates, previews, creates, runs and enables a rule withcurlandjq. 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
.mdfiles, no code. Language copies are generated by the translation workflow.hugo --minify --gc --config config/production/hugo.tomlbuilds clean, as invalidate_docs_build.yml.Documentation
This PR is the documentation change.
🤖 Generated with Claude Code