Skip to main content
Manja / GitHub
Schema1.1.4object

code-scanning-analysis

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

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.

commit_sha string
required

The SHA of the commit to which the analysis you are uploading relates.

minLength:40

maxLength:40

pattern:^[0-9a-fA-F]+$

created_at string (date-time)
required

The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.

deletable boolean
required
environment string
required

Identifies the variable values associated with the environment in which this analysis was performed.

error string
required

Example:error reading field xyz

id integer
required

Unique identifier for this analysis.

ref string
required

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

results_count integer
required

The total number of results in the analysis.

rules_count integer
required

The total number of rules used in the analysis.

sarif_id string
required

An identifier for the upload.

Example:6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53

tool_name string
optional
url string (uri)
required

The REST API URL of the analysis resource.

warning string
required

Warning generated when processing the analysis

Example:123 results were ignored