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.

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

fix: [TKC-2799] more test workflow execution fields #175

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
17 changes: 16 additions & 1 deletion docs/articles/webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ The full TestSuiteExecution data model can be found [here](https://github.com/ku
### TestWorkflowExecution:

- `Id` - TestWorkflowExecution ID (for example, `64f8d5b2712890925aea51dc`)
- `Name` - TestWorkflow name (for example, `wf-postman-smoke-tests`)
- `Name` - TestWorkflow execution name (for example, `wf-postman-smoke-tests-1`)
- `Namepace` - TestWorkflowExecution namespace (for example, `my-testkube`)
- `Number` - TestWorkflowExecution sequence number
- `ScheduledAt` - TestWorkflow scheduled time (for example, `2023-09-06 19:23:34.543433547 +0000 UTC`)
Expand All @@ -462,6 +462,21 @@ The full TestSuiteExecution data model can be found [here](https://github.com/ku

The full TestWorkflowExecution data model can be found [here](https://github.com/kubeshop/testkube/blob/main/pkg/api/v1/testkube/model_test_workflow_execution.go).

#### TestWorkflow for TestWorkflowExecution Workflow and ResolvedWorkflow fields:

- `Workflow.Name` - TestWorkflow name (for example, `wf-postman-smoke-tests`)
- `Workflow.Description` - TestWorkflow description (for example, `postman smoke tests to run after application deployment`)

The full TestWorkflow data model can be found [here](https://github.com/kubeshop/testkube/blob/main/pkg/api/v1/testkube/model_test_workflow.go).

#### TestWorkflowResult for TestWorkflowExecution Result field:

- `Reslut.FinishedAt` - TestWorkflow execution finished time(for example, `2024-11-15 11:24:37.129 +0000 UTC`)
- `Reslut.Duration` - TestWorkflow execution duration (for example, `8.504s`)
- `Reslut.Status` - TestWorkflow execution status (for example, `passed`)

The full TestWorkflowResult data model can be found [here](https://github.com/kubeshop/testkube/blob/main/pkg/api/v1/testkube/model_test_workflow_result.go).

### Additional Top-level Variables:

- `ExecutionCommand` - The CLI command to access the execution (example: `kubectl testkube get execution 6679893e3b11f4e4900e17a5`).
Expand Down