code-scanning-analysis

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
ref	object
commit_sha	object
analysis_key	object
environment	object
category	object
error	string
created_at	object
results_count	integer	The total number of results in the analysis.
rules_count	integer	The total number of rules used in the analysis.
id	integer	Unique identifier for this analysis.
url	object
sarif_id	object
tool	object
deletable	boolean
warning	string	Warning generated when processing the analysis

View JSON Schema on GitHub

JSON Schema

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