Fetch CI checks for a report's implementation PR

v1.0.0

Fetch the CI status (GitHub Actions check runs and legacy commit statuses) of the pull request attached to the report, via the team's GitHub integration.

Input

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "project_id": {
      "type": "string"
    },
    "pull_request_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "id",
    "project_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Response for the PR checks endpoint — the CI status of a report's implementation PR.",
  "required": [
    "checks"
  ],
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "One CI check on a pull request's head commit — a GitHub Actions check run or a legacy commit\nstatus, normalized to a common shape.",
        "required": [
          "conclusion",
          "name",
          "status",
          "url"
        ],
        "properties": {
          "conclusion": {
            "type": [
              "string",
              "null"
            ],
            "description": "Outcome once completed: 'success', 'failure', 'neutral', 'cancelled', 'skipped', 'timed_out', or 'action_required'. Null while still running."
          },
          "name": {
            "type": "string",
            "description": "Check run name or status context."
          },
          "status": {
            "type": [
              "string",
              "null"
            ],
            "description": "Lifecycle state: 'queued', 'in_progress', or 'completed'."
          },
          "url": {
            "type": [
              "string",
              "null"
            ],
            "description": "Link to the check run / status detail on GitHub."
          }
        }
      }
    }
  }
}