Class CustomRuleRevisionInput

A revision of a custom static analysis rule as embedded in a rule supplied by a create or update request. Nested revisions are sent flat, without a data/type/attributes envelope. id, version_id, checksum, created_at and created_by are server-assigned and read-only; they are declared so that a ruleset previously read back can be supplied unchanged.

Hierarchy

  • CustomRuleRevisionInput

Constructors

constructor

Properties

arguments? category? checksum? code? createdAt? createdBy? creationMessage? cve? cwe? description? documentationUrl? id? isPublished? isTesting? language? severity? shortDescription? shouldUseAiFix? tags? tests? treeSitterQuery? versionId?

Constructors

constructor

Properties

Optional arguments

arguments?: Argument[]

Rule arguments

Optional category

category?: CustomRuleRevisionAttributesCategory

Rule category

Optional checksum

checksum?: string

Code checksum

Optional code

code?: string

Rule code

Optional createdAt

createdAt?: Date

Creation timestamp

Optional createdBy

createdBy?: string

Creator identifier

Optional creationMessage

creationMessage?: string

Revision creation message

Optional cve

cve?: string

Associated CVE

Optional cwe

cwe?: string

Associated CWE

Optional description

description?: string

Base64-encoded full description

Optional documentationUrl

documentationUrl?: string

Documentation URL

Optional id

id?: string

Revision identifier

Optional isPublished

isPublished?: boolean

Whether the revision should be published

Optional isTesting

isTesting?: boolean

Whether this is a testing revision

Optional language

language?: Language

Programming language

Optional severity

severity?: CustomRuleRevisionAttributesSeverity

Rule severity

Optional shortDescription

shortDescription?: string

Base64-encoded short description

Optional shouldUseAiFix

shouldUseAiFix?: boolean

Whether to use AI for fixes

Optional tags

tags?: string[]

Rule tags

Optional tests

tests?: CustomRuleRevisionTest[]

Rule tests

Optional treeSitterQuery

treeSitterQuery?: string

Tree-sitter query

Optional versionId

versionId?: number

Monotonically increasing version number of the revision.

Settings

Member Visibility

Theme

Generated using TypeDoc