API Reference

Builds

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Creates two comparable builds

post/v0/builds/compare

Create two builds whose outputs can be directly compared with each other.

Created builds modify their project branches so that their latest sets of config files point to the ones specified by the input revision.

This endpoint is useful because a build has more inputs than the set of config files it uses, so comparing two builds directly may return spurious differences. Builds made via this endpoint are guaranteed to have differences arising from the set of config files, and any custom code.

Body ParametersExpand Collapse

base: object { branch, revision, commit_message }

Parameters for the base build

branch: string

Branch to use. When using a branch name as revision, this must match or be omitted.

revision: string or map[FileInput]

Specifies what to build: a branch name, a commit SHA, or file contents.

Accepts one of the following:

UnionMember0 = string

A branch name, commit SHA, or merge command in the format "base..head"

UnionMember1 = map[FileInput]

File contents to commit directly

Accepts one of the following:

Content = object { content }

content: string

File content

URL = object { url }

url: string

URL to fetch file content from

commit_message: optional string

Optional commit message to use when creating a new commit.

head: object { branch, revision, commit_message }

Parameters for the head build

branch: string

Branch to use. When using a branch name as revision, this must match or be omitted.

revision: string or map[FileInput]

Specifies what to build: a branch name, a commit SHA, or file contents.

Accepts one of the following:

UnionMember0 = string

A branch name, commit SHA, or merge command in the format "base..head"

UnionMember1 = map[FileInput]

File contents to commit directly

Accepts one of the following:

Content = object { content }

content: string

File content

URL = object { url }

url: string

URL to fetch file content from

commit_message: optional string

Optional commit message to use when creating a new commit.

project: optional string

Project name

targets: optional array of Target

Optional list of SDK targets to build. If not specified, all configured targets will be built.

Accepts one of the following:

"node"

"typescript"

"python"

"go"

"java"

"kotlin"

"ruby"

"terraform"

"cli"

"php"

"csharp"

ReturnsExpand Collapse

base: Build { id, config_commit, created_at, 6 more }

id: string

Build ID

config_commit: string

created_at: string

documented_spec: object { content, type } or object { expires, type, url }

Accepts one of the following:

UnionMember0 = object { content, type }

content: string

type: "content"

UnionMember1 = object { expires, type, url }

expires: string

type: "url"

url: string

object: "build"

org: string

project: string

targets: object { cli, csharp, go, 8 more }

cli: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

csharp: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

go: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

java: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

kotlin: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

node: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

php: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

python: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

ruby: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

terraform: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

typescript: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

updated_at: string

head: Build { id, config_commit, created_at, 6 more }

id: string

Build ID

config_commit: string

created_at: string

documented_spec: object { content, type } or object { expires, type, url }

Accepts one of the following:

UnionMember0 = object { content, type }

content: string

type: "content"

UnionMember1 = object { expires, type, url }

expires: string

type: "url"

url: string

object: "build"

org: string

project: string

targets: object { cli, csharp, go, 8 more }

cli: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

csharp: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

go: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

java: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

kotlin: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

node: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

php: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

python: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

ruby: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

terraform: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

typescript: optional BuildTarget { commit, install_url, lint, 4 more }

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

conclusion: "success" or "failure" or "skipped" or 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

updated_at: string

Creates two comparable builds

HTTP

HTTP

TypeScript

Python

Java

Go

curl https://api.stainless.com/v0/builds/compare \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $STAINLESS_API_KEY" \
    -d '{
          "base": {
            "branch": "branch",
            "revision": "string"
          },
          "head": {
            "branch": "branch",
            "revision": "string"
          },
          "project": "project"
        }'

200 example

{
  "base": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "head": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
}

Returns Examples

200 example

{
  "base": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "head": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
}