simple-check-suite

A suite of checks performed on the code of a given code change

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
after	string
app	object
before	string
conclusion	string
created_at	string
head_branch	string
head_sha	string	The SHA of the head commit that is being checked.
id	integer
node_id	string
pull_requests	array
repository	object
status	string
updated_at	string
url	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/simple-check-suite",
  "title": "simple-check-suite",
  "description": "A suite of checks performed on the code of a given code change",
  "type": "object",
  "properties": {
    "after": {
      "example": "d6fde92930d4715a2b49857d24b940956b26d2d3",
      "type": "string",
      "nullable": true
    },
    "app": {
      "$ref": "#/components/schemas/integration"
    },
    "before": {
      "example": "146e867f55c26428e5f9fade55a9bbf5e95a7912",
      "type": "string",
      "nullable": true
    },
    "conclusion": {
      "example": "neutral",
      "type": "string",
      "nullable": true,
      "enum": [
        "success",
        "failure",
        "neutral",
        "cancelled",
        "skipped",
        "timed_out",
        "action_required",
        "stale",
        "startup_failure"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "head_branch": {
      "example": "master",
      "type": "string",
      "nullable": true
    },
    "head_sha": {
      "description": "The SHA of the head commit that is being checked.",
      "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
      "type": "string"
    },
    "id": {
      "example": 5,
      "type": "integer"
    },
    "node_id": {
      "example": "MDEwOkNoZWNrU3VpdGU1",
      "type": "string"
    },
    "pull_requests": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/pull-request-minimal"
      }
    },
    "repository": {
      "$ref": "#/components/schemas/minimal-repository"
    },
    "status": {
      "example": "completed",
      "type": "string",
      "enum": [
        "queued",
        "in_progress",
        "completed",
        "pending",
        "waiting"
      ]
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "url": {
      "example": "https://api.github.com/repos/github/hello-world/check-suites/5",
      "type": "string"
    }
  }
}