Optional additionalA container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.
Optional argumentsThe configurable arguments accepted by the rule. Forwarded from the rulesets endpoints; ignored by this operation.
The category of the rule (for example, BEST_PRACTICES, SECURITY).
A checksum of the rule definition.
The base64-encoded rule implementation code.
Optional createdThe date and time when the rule was created. Server-assigned by the rulesets endpoints; ignored by this operation.
Optional createdThe identifier of the user or system that created the rule. Server-assigned by the rulesets endpoints; ignored by this operation.
Optional cveThe CVE identifier associated with the rule. Forwarded from the rulesets endpoints; ignored by this operation.
Optional cweThe CWE identifier associated with the rule. Forwarded from the rulesets endpoints; ignored by this operation.
Optional descriptionA detailed explanation of what the rule detects. Forwarded from the rulesets endpoints; ignored by this operation.
Optional documentationA URL pointing to the rule documentation. Forwarded from the rulesets endpoints; ignored by this operation.
Optional entityThe code entity type checked by the rule, applicable when rule type is AST_CHECK.
The unique identifier of the rule.
Optional isWhether the rule is published. Forwarded from the rulesets endpoints; ignored by this operation.
Optional isWhether the rule is in testing mode. Forwarded from the rulesets endpoints; ignored by this operation.
The programming language this rule targets.
Optional lastThe date and time when the rule was last modified. Server-assigned by the rulesets endpoints; ignored by this operation.
Optional lastThe identifier of the user or system that last updated the rule. Server-assigned by the rulesets endpoints; ignored by this operation.
Optional nameThe name of the rule. Forwarded from the rulesets endpoints; ignored by this operation.
Optional regexA base64-encoded regex pattern used by the rule, applicable when rule type is REGEX.
The severity of findings from this rule (for example, ERROR, WARNING).
Optional shortA brief summary of what the rule detects. Forwarded from the rulesets endpoints; ignored by this operation.
Optional shouldWhether an AI-generated fix should be offered. Forwarded from the rulesets endpoints; ignored by this operation.
Optional testsThe test cases associated with the rule. Forwarded from the rulesets endpoints; ignored by this operation.
The base64-encoded tree-sitter query used by the rule.
The rule type indicating the detection mechanism (for example, TREE_SITTER_QUERY).
Generated using TypeDoc
A static analysis rule to apply during code analysis. Clients forward complete rule objects returned by the rulesets endpoints, so every member of that resource is declared here; only
id,category,checksum,language,severity,tree_sitter_query,entity_checked,regex,typeandcodeare read by this operation and the rest are ignored. The schema stays open so that any member beyond the forwarded rule resource is reported as a promotion candidate rather than rejected; it can be closed once that telemetry confirms none remain.