ESescape
RegressionTests
Beta

Update a regression test

Update the name and/or the additional context of a regression test.

put/regression-tests/{regressionTestId}

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

regressionTestIdstring uuid required

The regression test ID

Example:00000000-0000-0000-0000-000000000000

Request body

namestring

The new name of the regression test

additionalContextstring

The new free-form context given to the agent

Example request

{
  "name": "Checkout regression test",
  "additionalContext": "Focus on the checkout flow."
}

Response

OK

idstring uuid required

The id of the regression test

namestring required

The name of the regression test

additionalContextstring required

Free-form context given to the agent alongside the source report

inputFilenamestring required

The name of the uploaded source report file

inputFormat'MARKDOWN' | 'PDF' required

The format of the source report

status'CANCELLED' | 'CLARIFICATION_GIVEN' | 'CLARIFICATION_REQUIRED' | 'ERROR' | 'NOT_STARTED' | 'RUNNING' | 'TEST_FAILED' | 'TEST_PASSED' required

The status of the latest run of the regression test

signedUrlstring required

A signed URL to download the source report. It expires after a short period.

createdAtstring required

When the regression test was created

updatedAtstring required

When the regression test was last updated

hasMoreRunsboolean required

Whether more runs exist beyond the embedded runs. Page through all runs with GET /v3/regression-tests/{regressionTestId}/history.

Changes

No recorded changes to this operation across all 1 revision of this API.