Test Signature

API Reference - Test Signature resource

Test Signature is a unique test identifier in Currents. Multiple recordings of the same test case share the same signature.

It is based on the combination of the organization ID, the project ID, the spec file path, and the test title.

Generate Test Signature

POST v1/signature/test

Request Body

{
    "projectId": "Currents project id",
    "specFilePath": "the spec file path",
    "testTitle": ["title part 1", "title part 2"]
}

Request Body Parameters

Name	Type	Description
projectId*	string	Project ID. See Projects
specFilePath*	string	Relative path to the test spec file. See Spec Files Explorer - API and Spec File Path
testTitle*	string[]	Hierarchical test title array, e.g., ['describe', 'title']

Response

200: OK Successful Response

type ResponsePayload = {
  status: "OK";
  data: {
    signature: string;
  }
};

400: Bad Request Invalid parameters

{
    "status": "FAILED",
    "error": "Missing required parameter: projectId"
}

401: Unauthorized Invalid API key

{
    "status": "FAILED",
    "error": "Invalid API key provided"
}

403: Forbidden Insufficient permissions

{
    "status": "FAILED",
    "error": "Insufficient permissions to generate test signatures"
}

422: Unprocessable Entity Invalid data

{
    "status": "FAILED",
    "error": "Invalid testTitle format. Must be a non-empty array"
}

Spec File Path

Spec file path is the filesystem path as reported by your test runner. Some test runners (e.g., Postman) use the associated collection name. Examples:

• navigation.spec.ts

• e2e/navigation/menu.spec.ts

• Render Embed Pages (Postman collection name)

Test Title

Test title is an array of strings representing the canonical title of the test in the suite, including test group names. For example:

test.describe("navigation", () => {
    test("menu should open", () => {
        // ...
    }
})

Becomes ['navigation', 'menu should open']

You can also send a single string with test title elements joined by >, e.g.: navigation > menu should open