Github API - Test Config

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.

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

commit_sha code-scanning-analysis-commit-sha

code-scanning-analysis-commit-sha [scalar]

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

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

created_at code-scanning-analysis-created-at

code-scanning-analysis-created-at [scalar]

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

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

deletable boolean

boolean [scalar]

The OpenAPI boolean type

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

environment code-scanning-analysis-environment

code-scanning-analysis-environment [scalar]

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

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

error string

string [scalar]

The OpenAPI string type

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

id integer

integer [scalar]

The OpenAPI integer type

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

Unique identifier for this analysis.

ref code-scanning-ref

code-scanning-ref [scalar]

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

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

results_count integer

integer [scalar]

The OpenAPI integer type

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

The total number of results in the analysis.

rules_count integer

integer [scalar]

The OpenAPI integer type

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

The total number of rules used in the analysis.

sarif_id code-scanning-analysis-sarif-id

code-scanning-analysis-sarif-id [scalar]

An identifier for the upload.

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

tool code-scanning-analysis-tool

code-scanning-analysis-tool [object]

Attributes

guid code-scanning-analysis-tool-guid

name code-scanning-analysis-tool-name

version code-scanning-analysis-tool-version

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

url code-scanning-analysis-url

code-scanning-analysis-url [scalar]

The REST API URL of the analysis resource.

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

warning string

string [scalar]

The OpenAPI string type

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com

Warning generated when processing the analysis

API:

Github Open API

(version: 1.1.4)

Base Url:https://api.github.com