API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Projects

Retrieve project

client.projects.retrieve(ProjectRetrieveParams { project } params?, RequestOptionsoptions?): Project { config_repo, display_name, object, 3 more }

GET/v0/projects/{project}

Update project

client.projects.update(ProjectUpdateParams { project, display_name } params?, RequestOptionsoptions?): Project { config_repo, display_name, object, 3 more }

PATCH/v0/projects/{project}

List projects

client.projects.list(ProjectListParams { cursor, limit, org } query?, RequestOptionsoptions?): Page<Project { config_repo, display_name, object, 3 more } >

GET/v0/projects

Create project

client.projects.create(ProjectCreateParams { display_name, org, revision, 2 more } body, RequestOptionsoptions?): Project { config_repo, display_name, object, 3 more }

POST/v0/projects

Generate an AI commit message for a specific SDK

client.projects.generateCommitMessage(ProjectGenerateCommitMessageParams { project, target, base_ref, head_ref } params, RequestOptionsoptions?): ProjectGenerateCommitMessageResponse { ai_commit_message }

POST/v0/projects/{project}/generate_commit_message

ModelsExpand Collapse

Project { config_repo, display_name, object, 3 more }

A project is a collection of SDKs generated from the same set of config files.

config_repo: string

display_name: string | null

object: "project"

org: string

slug: string

targets: Array<Target>

One of the following:

"node"

"typescript"

"python"

"go"

"java"

"kotlin"

"ruby"

"terraform"

"cli"

"php"

"csharp"

"sql"

"openapi"

ProjectGenerateCommitMessageResponse { ai_commit_message }

ai_commit_message: string

ProjectsBranches

Create a new project branch

client.projects.branches.create(BranchCreateParams { project, branch, branch_from, force } params, RequestOptionsoptions?): ProjectBranch { branch, config_commit, latest_build, 3 more }

POST/v0/projects/{project}/branches

Retrieve a project branch

client.projects.branches.retrieve(stringbranch, BranchRetrieveParams { project } params?, RequestOptionsoptions?): ProjectBranch { branch, config_commit, latest_build, 3 more }

GET/v0/projects/{project}/branches/{branch}

List project branches

client.projects.branches.list(BranchListParams { project, cursor, limit } params?, RequestOptionsoptions?): Page<BranchListResponse { branch, config_commit, latest_build_id, 3 more } >

GET/v0/projects/{project}/branches

Delete a project branch

client.projects.branches.delete(stringbranch, BranchDeleteParams { project } params?, RequestOptionsoptions?): BranchDeleteResponse

DELETE/v0/projects/{project}/branches/{branch}

Rebase a project branch

client.projects.branches.rebase(stringbranch, BranchRebaseParams { project, base } params?, RequestOptionsoptions?): ProjectBranch { branch, config_commit, latest_build, 3 more }

PUT/v0/projects/{project}/branches/{branch}/rebase

Reset

client.projects.branches.reset(stringbranch, BranchResetParams { project, target_config_sha } params?, RequestOptionsoptions?): ProjectBranch { branch, config_commit, latest_build, 3 more }

PUT/v0/projects/{project}/branches/{branch}/reset

ModelsExpand Collapse

ProjectBranch { branch, config_commit, latest_build, 3 more }

A project branch names a line of development for a project. Like a Git branch, it points to a Git commit with a set of config files. In addition, a project branch also points to a set of custom code changes, corresponding to Git branches in the staging repos.

branch: string

Branch name

config_commit: ConfigCommit { repo, sha, stats, tree_oid }

A Git commit that points to the latest set of config files on a given branch.

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

latest_build: Build { id, config_commit, created_at, 6 more } | null

id: string

Build ID

config_commit: string

created_at: string

documented_spec: UnionMember0 { content, type } | UnionMember1 { expires, type, url } | null

One of the following:

UnionMember0 { content, type }

content: string

type: "content"

UnionMember1 { expires, type, url }

expires: string

type: "url"

url: string

object: "build"

org: string

project: string

targets: Targets { cli, csharp, go, 10 more }

cli?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

csharp?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

go?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

java?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

kotlin?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

node?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

openapi?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

php?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

python?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

ruby?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

sql?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

terraform?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

typescript?: BuildTarget { commit, install_url, object, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, completed_at, 3 more }

One of the following:

NotStarted { status }

status: "not_started"

Queued { status }

status: "queued"

InProgress { status }

status: "in_progress"

Completed { commit, completed, completed_at, 3 more }

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed: Completed { commit, completed_at, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha, stats, tree_oid } | null

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

completed_at: string

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

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: MergeConflictPr | null

number: number

repo: Repo { host, name, owner }

host: string

name: string

owner: string

status: "completed"

install_url: string | null

object: "build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

One of the following:

"not_started"

"codegen"

"postgen"

"completed"

build?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

lint?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

test?: CheckStep

One of the following:

NotStarted { status }

status: "not_started"

Queued { status, url }

status: "queued"

url: string | null

InProgress { status, url }

status: "in_progress"

url: string | null

Completed { completed, conclusion, status, url }

completed: Completed { conclusion, url }

deprecated

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

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

One of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

status: "completed"

url: string | null

updated_at: string

object: "project_branch"

org: string

project: string

Project name

BranchListResponse { branch, config_commit, latest_build_id, 3 more }

A project branch names a line of development for a project. Like a Git branch, it points to a Git commit with a set of config files. In addition, a project branch also points to a set of custom code changes, corresponding to Git branches in the staging repos.

branch: string

Branch name

config_commit: ConfigCommit { repo, sha, stats, tree_oid }

A Git commit that points to the latest set of config files on a given branch.

repo: Repo { branch, host, name, owner }

branch: string

host: string

name: string

owner: string

sha: string

stats: Stats | null

additions: number

deletions: number

total: number

tree_oid: string | null

latest_build_id: string

object: "project_branch"

org: string

project: string

Project name

BranchDeleteResponse = unknown

ProjectsConfigs

Retrieve configuration files

client.projects.configs.retrieve(ConfigRetrieveParams { project, branch, include } params?, RequestOptionsoptions?): ConfigRetrieveResponse { content }

GET/v0/projects/{project}/configs

Generate config suggestions

client.projects.configs.guess(ConfigGuessParams { project, spec, branch } params, RequestOptionsoptions?): ConfigGuessResponse { content }

POST/v0/projects/{project}/configs/guess

ModelsExpand Collapse

ConfigRetrieveResponse = Record<string, item>

Config files contents

content: string

The file content

ConfigGuessResponse = Record<string, item>

Config files contents

content: string

The file content