Skip to main content
Read a compiler-validated source proposal

Authorizations

Authorization
string
header
required

Opaque control credential

Path Parameters

projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
authoringSessionId
string
required
Pattern: ^authsess_[0-9a-z]{12,32}$
authoringProposalId
string
required
Pattern: ^aprop_[0-9a-z]{12,32}$

Response

Read a compiler-validated source proposal

schemaVersion
enum<number>
required
Available options:
1
authoringProposalId
string
required
Pattern: ^aprop_[0-9a-z]{12,32}$
authoringSessionId
string
required
Pattern: ^authsess_[0-9a-z]{12,32}$
organizationId
string
required
Pattern: ^org_[0-9a-z]{12,32}$
projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
baseRevision
string
required
Pattern: ^[0-9a-f]{40}$
state
enum<string>
required
Available options:
ready,
publishing,
published,
discarded,
superseded
artifactDigest
string
required
Pattern: ^sha256:[0-9a-f]{64}$
changedFiles
object[]
required
Required array length: 1 - 200 elements
buildHash
string
required
Pattern: ^sha256:[0-9a-f]{64}$
diagnostics
object[]
required
Maximum array length: 2000
version
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
createdAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
updatedAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
source
enum<string>
default:agent
required
Available options:
agent
authoringTurnId
string
required
Pattern: ^aturn_[0-9a-z]{12,32}$
pullRequestNumber
integer
Required range: 0 < x <= 9007199254740991
pullRequestUrl
string<uri>
Maximum string length: 4096
publishedRevision
string
Pattern: ^[0-9a-f]{40}$
publishedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991