[SEC-30403] Add API schema reference to Cloud SIEM detection rule docs#36142
Draft
chelsea-xu-dd wants to merge 2 commits intomasterfrom
Draft
[SEC-30403] Add API schema reference to Cloud SIEM detection rule docs#36142chelsea-xu-dd wants to merge 2 commits intomasterfrom
chelsea-xu-dd wants to merge 2 commits intomasterfrom
Conversation
Adds a self-contained "API schema reference" section to each Cloud SIEM detection method page so AI coding agents can author rules by fetching a single per-method doc instead of parsing the full Security Monitoring API reference (~51k lines). Each page now covers: top-level payload fields, queries schema, cases schema, options common fields, the method-specific options sub-object, and an example payload. Also adds the case condition grammar — an ANTLR-backed operator set (`>`, `>=`, `<`, `<=`, `&&`, `||`, `THEN`, `*`) with an explicit list of rejected operators. Corrects the public docs on operand ordering: both `query op NUMBER` and `NUMBER op query` forms are valid. Changes: - anomaly.md: add schema reference + anomalyDetectionOptions - content_anomaly.md: add schema reference - impossible_travel.md: add schema reference + exact thresholds - new_value.md: add schema reference + newValueOptions + limits - sequence.md: add schema reference + sequenceDetectionOptions - real_time_rule.md: add threshold schema + full case grammar - third_party.md (new): full third_party schema + vendor patterns - suppressions.md: deprecation note for legacy `filters` field Field descriptions reuse the existing API reference wording where available to keep terminology consistent.
Contributor
Add missing Third Party side-panel nav entry and rephrase the API schema reference intro on each detection method page to frame the section as the rule schema with a reference to the Security Monitoring API, instead of describing specific endpoints. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Editorial review tracked in DOCS-14084. |
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
Adds an API schema reference section to each Cloud SIEM detection method documentation page, so AI coding agents can author detection rules by fetching a single per-method doc instead of parsing the full Security Monitoring API reference (~51k lines).
Motivation
Cloud SIEM pod (SEC-30403) is building an MCP tool to help agents author detection rules via the v2 API. Originally scoped as a static schema tool, but the pod's direction is to have agents fetch schema from public docs on demand (following the
pup security findings schemapattern) to avoid sync drift between static content and the real API.For that to work, the public docs need enough schema detail to be self-sufficient. Today they are UI-focused and miss non-OpenAPI content: case condition grammar, field-level constraints, method-specific behavioral thresholds, and the
third_partyschema.What's in this PR
Every detection method page becomes a self-contained schema reference for that method. An agent authoring a
new_valuerule can fetch justnew_value.mdand have everything it needs.anomaly.mdanomalyDetectionOptions+ case condition subsetcontent_anomaly.mdimpossible_travel.mdimpossibleTravelOptions+ exact 1000 km/h / 500 km thresholdsnew_value.mdnewValueOptions+ limits (max 5 attributes, 30-day caps)sequence.mdsequenceDetectionOptions+ 24h constraint +THENprohibitionreal_time_rule.mdquery op NUMBERandNUMBER op queryforms are valid)third_party.md(new)third_partyschema includingthirdPartyRuleOptions,rootQueries, vendor patternssuppressions.mdfiltersarray field on rule payloadsDesign notes
.mdoutput agents fetch but are stripped from the human-facing HTML — addressing HTML hygiene without changing what agents receive. Cross-file deduplication (Hugo partials) is a separate, orthogonal tool that can be adopted later if the authoring burden becomes painful.signal_correlationis intentionally omitted from this PR (pending internal rework). Can be added in a follow-up.Scope / non-goals
Test plan
.mdversions are served cleanly to agent user-agents (WEB-8445)NUMBER op querycorrection doesn't contradict any other docs or UI guidance🤖 Generated with Claude Code