Workflow Run

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/workflow-run",
  "title": "Workflow Run",
  "description": "An invocation of a workflow",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the workflow run.",
      "example": 5
    },
    "name": {
      "type": "string",
      "description": "The name of the workflow run.",
      "nullable": true,
      "example": "Build"
    },
    "node_id": {
      "type": "string",
      "example": "MDEwOkNoZWNrU3VpdGU1"
    },
    "check_suite_id": {
      "type": "integer",
      "description": "The ID of the associated check suite.",
      "example": 42
    },
    "check_suite_node_id": {
      "type": "string",
      "description": "The node ID of the associated check suite.",
      "example": "MDEwOkNoZWNrU3VpdGU0Mg=="
    },
    "head_branch": {
      "type": "string",
      "nullable": true,
      "example": "master"
    },
    "head_sha": {
      "description": "The SHA of the head commit that points to the version of the workflow being run.",
      "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
      "type": "string"
    },
    "path": {
      "description": "The full path of the workflow",
      "example": "octocat/octo-repo/.github/workflows/ci.yml@main",
      "type": "string"
    },
    "run_number": {
      "type": "integer",
      "description": "The auto incrementing run number for the workflow run.",
      "example": 106
    },
    "run_attempt": {
      "type": "integer",
      "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.",
      "example": 1
    },
    "referenced_workflows": {
      "type": "array",
      "nullable": true,
      "items": {
        "$ref": "#/components/schemas/referenced-workflow"
      }
    },
    "event": {
      "type": "string",
      "example": "push"
    },
    "status": {
      "type": "string",
      "nullable": true,
      "example": "completed"
    },
    "conclusion": {
      "type": "string",
      "nullable": true,
      "example": "neutral"
    },
    "workflow_id": {
      "type": "integer",
      "description": "The ID of the parent workflow.",
      "example": 5
    },
    "url": {
      "type": "string",
      "description": "The URL to the workflow run.",
      "example": "https://api.github.com/repos/github/hello-world/actions/runs/5"
    },
    "html_url": {
      "type": "string",
      "example": "https://github.com/github/hello-world/suites/4"
    },
    "pull_requests": {
      "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.",
      "type": "array",
      "nullable": true,
      "items": {
        "$ref": "#/components/schemas/pull-request-minimal"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "actor": {
      "$ref": "#/components/schemas/simple-user"
    },
    "triggering_actor": {
      "$ref": "#/components/schemas/simple-user"
    },
    "run_started_at": {
      "type": "string",
      "format": "date-time",
      "description": "The start time of the latest run. Resets on re-run."
    },
    "jobs_url": {
      "description": "The URL to the jobs for the workflow run.",
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs"
    },
    "logs_url": {
      "description": "The URL to download the logs for the workflow run.",
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs"
    },
    "check_suite_url": {
      "description": "The URL to the associated check suite.",
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/check-suites/12"
    },
    "artifacts_url": {
      "description": "The URL to the artifacts for the workflow run.",
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts"
    },
    "cancel_url": {
      "description": "The URL to cancel the workflow run.",
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel"
    },
    "rerun_url": {
      "description": "The URL to rerun the workflow run.",
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun"
    },
    "previous_attempt_url": {
      "nullable": true,
      "description": "The URL to the previous attempted run of this workflow, if one exists.",
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3"
    },
    "workflow_url": {
      "description": "The URL to the workflow.",
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml"
    },
    "head_commit": {
      "$ref": "#/components/schemas/nullable-simple-commit"
    },
    "repository": {
      "$ref": "#/components/schemas/minimal-repository"
    },
    "head_repository": {
      "$ref": "#/components/schemas/minimal-repository"
    },
    "head_repository_id": {
      "type": "integer",
      "example": 5
    },
    "display_title": {
      "type": "string",
      "example": "Simple Workflow",
      "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow."
    }
  },
  "required": [
    "id",
    "node_id",
    "head_branch",
    "run_number",
    "display_title",
    "event",
    "status",
    "conclusion",
    "head_sha",
    "path",
    "workflow_id",
    "url",
    "html_url",
    "created_at",
    "updated_at",
    "head_commit",
    "head_repository",
    "repository",
    "jobs_url",
    "logs_url",
    "check_suite_url",
    "cancel_url",
    "rerun_url",
    "artifacts_url",
    "workflow_url",
    "pull_requests"
  ]
}