Skip to main content
POST
Report what a runner's code review of a build did

Authorizations

X-Outerlayer-App-Id
string
header
required

Factory id the request is scoped to.

Authorization
string
header
required

API key (sk_outerlayer_*)

Headers

Signature
string

HTTP Message Signature (RFC 9421) made with the runner key's host key: runner=:<base64>:.

Signature-Input
string

The signature's covered components and parameters: runner=("@method" "@path" "@query" "content-digest");created=<unix seconds>;nonce="<random>";keyid="<host key fingerprint>";alg="ed25519".

Content-Digest
string

RFC 9530 digest of the request body, always sent, including for a request with none: sha-256=:<base64>:.

Path Parameters

workItemId
string
required

Body

application/json
reason
enum<string>
required

reviewed for a review, review_not_run for a failure, or the reason the runner did not review.

Available options:
reviewed,
review_not_run,
nothing_new,
already_reviewed,
several_pull_requests,
other_repository,
own_provision_hook,
sandbox,
variables_lost,
review_stopped
result
enum<string>
required

reviewed: the code review ran. failed: it could not run. skipped: the runner chose not to review.

Available options:
reviewed,
failed,
skipped
commit
string

The commit the code review covers, or the commit that already has a review.

Pattern: ^[0-9a-f]{40}$
problems
integer

The problems the code review found. Only with reviewed.

Required range: 0 <= x <= 100000
review
object

The problems, reviewers and files of the code review. Only with reviewed.

runnerReason
string

Why the code review could not run. Only with failed. OuterLayer keeps the first 200 characters, on one line.

Maximum string length: 2000

Response

The report is handled.

data
object
required