completed.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "check_suite$completed",
  "type": "object",
  "required": ["action", "check_suite", "repository", "sender"],
  "properties": {
    "action": { "type": "string", "enum": ["completed"] },
    "check_suite": {
      "type": "object",
      "description": "The [check_suite](https://docs.github.com/en/rest/reference/checks#suites).",
      "required": [
        "id",
        "node_id",
        "head_branch",
        "head_sha",
        "status",
        "conclusion",
        "url",
        "before",
        "after",
        "pull_requests",
        "app",
        "created_at",
        "updated_at",
        "latest_check_runs_count",
        "check_runs_url",
        "head_commit"
      ],
      "properties": {
        "id": { "type": "integer" },
        "node_id": { "type": "string" },
        "head_branch": {
          "type": ["string", "null"],
          "description": "The head branch name the changes are on."
        },
        "head_sha": {
          "type": "string",
          "description": "The SHA of the head commit that is being checked."
        },
        "status": {
          "type": ["string", "null"],
          "enum": ["requested", "in_progress", "completed", "queued", null],
          "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`."
        },
        "conclusion": {
          "type": ["string", "null"],
          "enum": [
            "success",
            "failure",
            "neutral",
            "cancelled",
            "timed_out",
            "action_required",
            "stale",
            null
          ],
          "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`."
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "URL that points to the check suite API resource."
        },
        "before": { "type": ["string", "null"] },
        "after": { "type": ["string", "null"] },
        "pull_requests": {
          "type": "array",
          "items": { "$ref": "common/check-run-pull-request.schema.json" },
          "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
        },
        "app": { "$ref": "common/app.schema.json" },
        "created_at": { "type": "string", "format": "date-time" },
        "updated_at": { "type": "string", "format": "date-time" },
        "latest_check_runs_count": { "type": "integer" },
        "check_runs_url": { "type": "string", "format": "uri" },
        "head_commit": { "$ref": "common/commit-simple.schema.json" }
      },
      "additionalProperties": false
    },
    "repository": { "$ref": "common/repository.schema.json" },
    "sender": { "$ref": "common/user.schema.json" },
    "installation": { "$ref": "common/installation-lite.schema.json" },
    "organization": { "$ref": "common/organization.schema.json" }
  },
  "additionalProperties": false,
  "title": "check_suite completed event"
}