Skip to content
FeedbackDashboard

Builds

List project builds
builds.list(BuildListParams**kwargs) -> SyncPage[Build]
get/v0/builds
Create build
builds.create(BuildCreateParams**kwargs) -> Build
post/v0/builds
Retrieve build
builds.retrieve(strbuild_id) -> Build
get/v0/builds/{buildId}
Creates two comparable builds
builds.compare(BuildCompareParams**kwargs) -> BuildCompareResponse
post/v0/builds/compare
ModelsExpand Collapse
class Build:
id: str

Build ID

config_commit: str
created_at: datetime
documented_spec: Optional[DocumentedSpec]
Accepts one of the following:
class DocumentedSpecUnionMember0:
content: str
type: Literal["content"]
class DocumentedSpecUnionMember1:
expires: datetime
type: Literal["url"]
url: str
object: Literal["build"]
org: str
project: str
targets: Targets
cli: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
csharp: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
go: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
java: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
kotlin: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
node: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
php: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
python: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
ruby: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
terraform: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
typescript: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
updated_at: datetime
class BuildTarget:
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
class CommitQueued:
status: Literal["queued"]
class CommitInProgress:
status: Literal["in_progress"]
class CommitCompleted:
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: CommitConclusion
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
conclusion: CommitConclusion
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["build_target"]
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
CheckStep = CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
class Queued:
status: Literal["queued"]
class InProgress:
status: Literal["in_progress"]
class Completed:
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
CheckStepConclusion = Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"

BuildsDiagnostics

Get diagnostics for a build
builds.diagnostics.list(strbuild_id, DiagnosticListParams**kwargs) -> SyncPage[BuildDiagnostic]
get/v0/builds/{buildId}/diagnostics
ModelsExpand Collapse
class BuildDiagnostic:
code: str

The kind of diagnostic.

ignored: bool

Whether the diagnostic is ignored in the Stainless config.

level: Literal["fatal", "error", "warning", "note"]

The severity of the diagnostic.

Accepts one of the following:
"fatal"
"error"
"warning"
"note"
message: str

A description of the diagnostic.

more: Optional[BuildDiagnosticMore]
Accepts one of the following:
class Markdown:
markdown: str
type: Literal["markdown"]
class Raw:
raw: str
type: Literal["raw"]
config_ref: Optional[str]

A JSON pointer to a relevant field in the Stainless config.

oas_ref: Optional[str]

A JSON pointer to a relevant field in the OpenAPI spec.

BuildDiagnosticMore = BuildDiagnosticMore
Accepts one of the following:
class Markdown:
markdown: str
type: Literal["markdown"]
class Raw:
raw: str
type: Literal["raw"]

BuildsTarget Outputs

Download build target output
builds.target_outputs.retrieve(TargetOutputRetrieveParams**kwargs) -> TargetOutputRetrieveResponse
get/v0/build_target_outputs