Skip to main content
Schema1.1.4object

code-scanning-alert-items

Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

code-scanning-alert-instance

object
analysis_key string
optional

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

category string
optional

Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.

classifications array
optional

Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file.

commit_sha string
optional
environment string
optional

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

html_url string
optional
message object
optional
ref string
optional

The full Git reference, formatted as `refs/heads/<branch name>`, `refs/pull/<number>/merge`, or `refs/pull/<number>/head`.

state
string<code-scanning-alert-state>
optional

State of a code scanning alert.