Skip to main content
GET
Read a task's recorded diff

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

taskID
string<uuid>
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

OK

A task's recorded diff as its readers read it.

additions
integer<int64>
required

The text files' added lines, summed.

Required range: 0 <= x <= 9007199254740991
base_branch
string
required

The branch on origin the diff is against, as getComputerWorkTreeDiffTarget names it.

Minimum string length: 1
Pattern: \S
base_ref
string
required

The merge base of HEAD and origin's base branch the diff runs from: a SHA-1 or SHA-256 commit.

Pattern: ^([0-9a-f]{40}|[0-9a-f]{64})$
deletions
integer<int64>
required

The text files' deleted lines, summed.

Required range: 0 <= x <= 9007199254740991
files
object[]
required

Every file the work tree changed, at most 3000 whose paths take at most 1048576 bytes together (more is the failure too_many_files), each display_path once. Their hunks take at most 1048576 bytes as a unified diff writes them: the file whose hunks would pass that, and every file after it, is omitted too_large.

Maximum array length: 3000

A file the work tree changed against the merge base, staged, unstaged or untracked alike: text, with its hunks, or omitted, with why.

last_failure
object | null
required

The latest attempt to record the diff, when it failed: newer than the recorded diff, or with none recorded. null otherwise. A failure never replaces a recorded diff.

recorded_at
string<date-time>
required

When the computer's bridge observed the diff shown, on its clock.

state
enum<string>
required
Available options:
recorded