Class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems

A static analysis rule within a ruleset, including its definition, metadata, and associated test cases.

Hierarchy

  • GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

The list of configurable arguments accepted by this rule.

category: string

The category classifying the type of issue this rule detects (e.g., security, style, performance).

checksum: string

A checksum of the rule definition used to detect changes.

code: string

The rule implementation code used by the static analysis engine.

createdAt: Date

The date and time when the rule was created.

createdBy: string

The identifier of the user or system that created the rule.

cve?: string

The CVE identifier associated with the vulnerability this rule detects, if applicable.

cwe?: string

The CWE identifier associated with the weakness category this rule detects, if applicable.

description: string

A detailed explanation of what the rule detects and why it matters.

documentationUrl?: string

A URL pointing to additional documentation for this rule.

entityChecked?: string

The code entity type (e.g., function, class, variable) that this rule inspects.

id: string

The unique identifier of the rule, which is the same as its name.

isPublished: boolean

Indicates whether the rule is publicly published and available to all users.

isTesting: boolean

Indicates whether the rule is in testing mode and not yet promoted to production.

language: string

The programming language this rule applies to.

lastUpdatedAt: Date

The date and time when the rule was last modified.

lastUpdatedBy: string

The identifier of the user or system that last updated the rule.

name: string

The unique name identifying this rule within its ruleset.

regex?: string

A regular expression pattern used by the rule for pattern-based detection.

severity: string

The severity level of findings produced by this rule (e.g., ERROR, WARNING, NOTICE).

shortDescription: string

A brief summary of what the rule detects, suitable for display in listings.

shouldUseAiFix: boolean

Indicates whether an AI-generated fix suggestion should be offered for findings from this rule.

The list of test cases used to validate the rule's behavior.

treeSitterQuery?: string

The Tree-sitter query expression used by the rule to match code patterns in the AST.

type: string

The rule type indicating the detection mechanism used (e.g., tree_sitter, regex).

Generated using TypeDoc