Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

parameter description #313

Merged
merged 1 commit into from
Nov 12, 2024
Merged

parameter description #313

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions execution-without-ci.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

<Frame caption="generate a test report from the terminal, screenshot 02/2024">
Expand All @@ -14,8 +14,6 @@ You can retrieve it conveniently with prefilled parameters from within the app b
/>
</Frame>

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
Expand All @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all of these are btw ALREADY explained in the API-reference, shouldn't we just LINK to it instead of duplicating it? Imho the api reference should be the single source of truth


- `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).
Expand Down