github.pulls.list_pr_files

List a GitHub pull request's changed files with bounded unified-diff patches.

Overview

Property	Value
Workflow type	Atomic
Library	App-github
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
actor	string	No	—	—
workflow_run_id	string	No	—	—
github_connection_uuid	uuid	No	—	—
repository	string	Yes	—	—
pull_number	integer	Yes	—	—
include_patch	boolean	No	—	Include per-file unified-diff hunks (default true).
max_files	integer	No	—	Files to return (default 100, hard cap 300).
max_patch_bytes_per_file	integer	No	—	Per-file patch byte cap (default 8192).
max_total_patch_bytes	integer	No	—	Total patch byte budget (default 262144).

Output Schema

Field	Type	Required	Default	Description
repository	string	No	—	—
pull_number	integer	No	—	—
files	list	No	—	Per-file rows: filename, status, additions, deletions, changes, previous_filename, sha, patch, patch_truncated, patch_omitted.
total_files	integer	No	—	—
files_returned	integer	No	—	—
files_omitted	integer	No	—	Changed files NOT in this response (beyond max_files).
patches_truncated	integer	No	—	—
patches_omitted	integer	No	—	—
complete	boolean	No	—	True ONLY when every changed file is present with its full patch. A reviewer must not approve on complete=false without reading the omitted/truncated files another way.
warnings	list	No	—	—
failure_reason	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—
failed_at	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	—
* (any state)	fail	failed	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "github.pulls.list_pr_files",
  "initial_data": {
    "organization_uuid": "value",
    "repository": "value",
    "pull_number": 123
  }
}