Signature

Generate test signatures.

Test signatures are unique identifiers for tests based on project, spec file path, and test title. They are used to track tests across multiple runs.

Get test signature

post

/signature/test

Generate a unique test signature based on project, spec file path, and test title

Authorizations

AuthorizationstringRequired

An organization API key, sent as Authorization: Bearer <key>. A key carries one scope for the whole API: a read key reaches the GET endpoints, a write key reaches all of them.

Body

projectIdstringRequired

The project ID

specFilePathstringRequired

Full path to the spec file

testTitleone ofRequired

Test title or array of titles (for nested describe blocks)

stringOptional

or

string[] · min: 1Optional

Responses

200

Successful response

application/json

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

403

The credential authenticated but is not permitted to use this endpoint. Four refusals share the status: a read API key on an endpoint that writes, an OAuth token that was not granted the scope the endpoint needs (insufficient_scope), an OAuth token that was granted it but whose holder no longer has a role permitting it (insufficient_role), and an OAuth token on an endpoint that accepts an API key and nothing else (api_key_required). Discriminate on code rather than on the message, which is free-form. The first refusal predates the codes and sets none. Only insufficient_scope carries the challenge header, because it is the only one a client can act on by re-authorizing.

application/json

404

Resource not found

application/json

post/signature/test

POST /v1/signature/test HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "projectId": "text",
  "specFilePath": "text",
  "testTitle": "text"
}

{
  "status": "OK",
  "data": {
    "signature": "text"
  }
}