Schema1.1.4object

code-scanning-analysis

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

code-scanning-analysis-tool

object

guid string

optionalnullable

The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.

name string

optional

The name of the tool used to generate the code scanning analysis.

version string

optionalnullable

The version of the tool used to generate the code scanning analysis.

Root JSON Schema

{"properties":{"analysis_key":{"$ref":"#/components/schemas/code-scanning-analysis-analysis-key"},"category":{"$ref":"#/components/schemas/code-scanning-analysis-category"},"commit_sha":{"$ref":"#/components/schemas/code-scanning-analysis-commit-sha"},"created_at":{"$ref":"#/components/schemas/code-scanning-analysis-created-at"},"deletable":{"type":"boolean"},"environment":{"$ref":"#/components/schemas/code-scanning-analysis-environment"},"error":{"example":"error reading field xyz","type":"string"},"id":{"description":"Unique identifier for this analysis.","type":"integer"},"ref":{"$ref":"#/components/schemas/code-scanning-ref"},"results_count":{"description":"The total number of results in the analysis.","type":"integer"},"rules_count":{"description":"The total number of rules used in the analysis.","type":"integer"},"sarif_id":{"$ref":"#/components/schemas/code-scanning-analysis-sarif-id"},"tool":{"$ref":"#/components/schemas/code-scanning-analysis-tool"},"tool_name":{"type":"string"},"url":{"$ref":"#/components/schemas/code-scanning-analysis-url"},"warning":{"description":"Warning generated when processing the analysis","example":"123 results were ignored","type":"string"}},"required":["ref","commit_sha","analysis_key","environment","error","created_at","results_count","rules_count","id","url","sarif_id","tool","deletable","warning"],"type":"object"}