CheckRun

A check performed on the code of a given code change

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
app	object
check_suite	object
completed_at	string
conclusion	string
deployment	object
details_url	string
external_id	string
head_sha	string	The SHA of the commit that is being checked.
html_url	string
id	integer	The id of the check.
name	string	The name of the check.
node_id	string
output	object
pull_requests	array
started_at	string
status	string	The phase of the lifecycle that the check is currently in.
url	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/check-run-with-simple-check-suite",
  "title": "CheckRun",
  "description": "A check performed on the code of a given code change",
  "type": "object",
  "properties": {
    "app": {
      "$ref": "#/components/schemas/nullable-integration"
    },
    "check_suite": {
      "$ref": "#/components/schemas/simple-check-suite"
    },
    "completed_at": {
      "example": "2018-05-04T01:14:52Z",
      "type": "string",
      "nullable": true,
      "format": "date-time"
    },
    "conclusion": {
      "example": "neutral",
      "type": "string",
      "nullable": true,
      "enum": [
        "waiting",
        "pending",
        "startup_failure",
        "stale",
        "success",
        "failure",
        "neutral",
        "cancelled",
        "skipped",
        "timed_out",
        "action_required"
      ]
    },
    "deployment": {
      "$ref": "#/components/schemas/deployment-simple"
    },
    "details_url": {
      "example": "https://example.com",
      "type": "string"
    },
    "external_id": {
      "example": "42",
      "type": "string"
    },
    "head_sha": {
      "description": "The SHA of the commit that is being checked.",
      "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
      "type": "string"
    },
    "html_url": {
      "example": "https://github.com/github/hello-world/runs/4",
      "type": "string"
    },
    "id": {
      "description": "The id of the check.",
      "example": 21,
      "type": "integer"
    },
    "name": {
      "description": "The name of the check.",
      "example": "test-coverage",
      "type": "string"
    },
    "node_id": {
      "example": "MDg6Q2hlY2tSdW40",
      "type": "string"
    },
    "output": {
      "type": "object",
      "properties": {
        "annotations_count": {
          "type": "integer"
        },
        "annotations_url": {
          "type": "string",
          "format": "uri"
        },
        "summary": {
          "type": "string",
          "nullable": true
        },
        "text": {
          "type": "string",
          "nullable": true
        },
        "title": {
          "type": "string",
          "nullable": true
        }
      },
      "required": [
        "title",
        "summary",
        "text",
        "annotations_count",
        "annotations_url"
      ]
    },
    "pull_requests": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/pull-request-minimal"
      }
    },
    "started_at": {
      "example": "2018-05-04T01:14:52Z",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "description": "The phase of the lifecycle that the check is currently in.",
      "example": "queued",
      "type": "string",
      "enum": [
        "queued",
        "in_progress",
        "completed",
        "pending"
      ]
    },
    "url": {
      "example": "https://api.github.com/repos/github/hello-world/check-runs/4",
      "type": "string"
    }
  },
  "required": [
    "id",
    "node_id",
    "head_sha",
    "name",
    "url",
    "html_url",
    "details_url",
    "status",
    "conclusion",
    "started_at",
    "completed_at",
    "external_id",
    "check_suite",
    "output",
    "app",
    "pull_requests"
  ]
}