From d634b1bd825f31a813bd8af8a2220fe9f905f335 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20R=C3=B6dler?= Date: Mon, 11 Nov 2024 18:15:28 +0100 Subject: [PATCH] parameter description --- execution-without-ci.mdx | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/execution-without-ci.mdx b/execution-without-ci.mdx index c3e11ae..a44ebd0 100644 --- a/execution-without-ci.mdx +++ b/execution-without-ci.mdx @@ -1,10 +1,10 @@ --- -title: Execute without CI +title: Execute via shell script description: "Trigger test execution from outside our app with a curl command" icon: "person-digging" --- -If you don't have pipelines and want to manually trigger the test execution from outside our app, you can do it with a **cURL command**. +If you need to trigger the test execution from outside our app, you can do it with a **cURL command**. You can retrieve it conveniently with prefilled parameters from within the app by selecting `in app via terminal` from the `generate report` button on the overview page: @@ -14,8 +14,6 @@ You can retrieve it conveniently with prefilled parameters from within the app b /> -You can see how to set up your `API key` below. - The command will return a response with a link to your test report and some other information, see the [API Reference](/api-reference). ```JSON @@ -26,6 +24,14 @@ The command will return a response with a link to your test report and some othe If you follow this link, you can find the test report containing all test results of your execution. +### Parameters + +- `x-api-key`: You can see how to set up your `API key` below at the end of the post. +- `url`: it is populated with the default url but you can exchange it against any url. +- `testTargetId`: will be set automatically on copy +- `environmentName`: will be set automatically on copy in case you have environments defined (this parameter is optional) +- `userId`: will be set automatically on copy + ### Blocking your pipeline You can block your pipeline by polling the resulting test-report until the status is "PASSED" with a call to the test report API - see our [API Reference](/api-reference).