code-scanning-sarifs-status

APIs.ioEngineeringPlatform

Properties

Name Type Description
processing_status string `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed.
analyses_url string The REST API URL for getting the analyses associated with the upload.
errors array Any errors that ocurred during processing of the delivery.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-code-scanning-sarifs-status-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/code-scanning-sarifs-status",
  "title": "code-scanning-sarifs-status",
  "type": "object",
  "properties": {
    "processing_status": {
      "type": "string",
      "enum": [
        "pending",
        "complete",
        "failed"
      ],
      "description": "`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed."
    },
    "analyses_url": {
      "type": "string",
      "description": "The REST API URL for getting the analyses associated with the upload.",
      "format": "uri",
      "readOnly": true,
      "nullable": true
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Any errors that ocurred during processing of the delivery.",
      "readOnly": true,
      "nullable": true
    }
  }
}