Reviews and evidence
Routes in this group. Authentication, scope and rate limit errors apply to every route and are on the errors page.
POST/projects/{slug}/evidence
Upload screenshots and logs to attach to a review.
- Scope
reviews:write- Rate bucket
upload, 8 an hour per key- Availability
- Answers 404 not_found where the streamlining flag is off.
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
slug | path | string | Yes |
Request. multipart/form-data with exactly one field, file, holding a ZIP of PNG, TXT, LOG or JSON files. PNG sides are at most 1400 pixels. Needs reviews:write and uses the upload bucket. This route answers 404 not_found where the streamlining flag is off.
Returns. evidenceSetId, sha256, created and the files (path, sha256, bytes). Pass evidenceSetId to POST /reviews.
Errors specific to this route. 404 not_found, 422 zip_file_required, 422 evidence_format, 422 evidence_dimensions, 422 invalid_zip, 413 request_too_large, 404 project_not_found. Authentication, scope and rate limit errors apply to every route.
POST/projects/{slug}/reviews
Submit a review of delivered assets.
- Scope
reviews:write- Rate bucket
write, 60 a minute per key
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
slug | path | string | Yes | |
evidenceSetId | query | string | No | max length 36 |
Request. JSON body: a myrlin.asset-review/1 document. Optional query evidenceSetId names an evidence upload. Needs reviews:write.
Returns. reviewId, reviewSha256, batchId, assets (the status of each reviewed asset), replayed, automaticRegeneration and evidenceSetId. A review of a rejected file can queue a free fix batch when fixes are switched on for the server. The same review sent twice returns the first result with replayed true.
Errors specific to this route. 422 invalid_review, 422 duplicate_review_asset, 404 batch_not_found, 409 review_batch_ambiguous, 409 review_result_unavailable, 422 review_asset_unknown, 422 review_file_unknown, 422 review_totals_mismatch, 409 review_zip_mismatch, 409 review_file_unavailable, 422 reviewer_name_too_long, 422 unknown_reviewer, 422 evidence_mismatch, 422 evidence_output_unknown, 422 evidence_text_too_long, 422 evidence_upload_required, 404 evidence_not_found, 409 evidence_replay_conflict, 404 project_not_found. Authentication, scope and rate limit errors apply to every route.