SparQDocs
GuidesAPI referencesparqhq.ai
API referenceChanges

Evaluate Draft

POST
/v1/admin/drafts/{draft_id}/evaluate

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Path Parameters

draft_id*Draft Id
Formatuuid

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid
Idempotency-Key?string

Makes a retry safe: the same key, route and body within 24 hours returns the stored response and the same result id. The same key with a different body or route is idempotency_conflict; while the first request runs, idempotency_in_progress.

Length8 <= length <= 128

Response Body

Successful Response

application/json
  1. response

An evaluation of a draft against its tests and the platform suites.

eval_run_id*Eval Run Id
Formatuuid
draft_id*Draft Id
Formatuuid
suite*Suite

Lower-case name: a letter, then letters, digits, '_' or '-'. Max 63.

Match^[a-z][a-z0-9_-]{0,62}$
status*EvalRunStatus
Value in"queued""running""passed""failed""error"
pass_rate*|null
leaks_found*|null
started_at*Started At
Formatdate-time
finished_at*|null
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/drafts/497f6eca-6276-4993-bfeb-53cbbbba6f08/evaluate'
Example Response
{  "eval_run_id": "8022d801-acb6-4836-b536-3cd4138b6ae0",  "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",  "suite": "string",  "status": "queued",  "pass_rate": 0,  "leaks_found": 0,  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z"}

Diff Draft GET

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version.

Get Change Request GET

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version.