A revision of a custom static analysis rule as embedded in a rule or ruleset response.

Hierarchy

  • CustomRuleRevisionEmbedded

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
arguments: null | Argument[]

Rule arguments

Rule category

checksum: string

Code checksum

code: string

Rule code

createdAt: Date

Creation timestamp

createdBy: string

Creator identifier

creationMessage: string

Revision creation message

cve?: string

Associated CVE. Omitted when the revision has no associated CVE.

cwe?: string

Associated CWE. Omitted when the revision has no associated CWE.

description: string

Full description

documentationUrl?: string

Documentation URL. Omitted when the revision has no documentation URL.

id: string

Revision identifier

isPublished: boolean

Whether the revision is published

isTesting: boolean

Whether this is a testing revision

language: Language

Programming language

Rule severity

shortDescription: string

Short description

shouldUseAiFix: boolean

Whether to use AI for fixes

tags: null | string[]

Rule tags

tests: null | CustomRuleRevisionTest[]

Rule tests

treeSitterQuery: string

Tree-sitter query

versionId: number

Monotonically increasing version number of the revision.

Generated using TypeDoc