New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

testkube-sdk

Package Overview
Dependencies
Maintainers
2
Versions
47
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

testkube-sdk - npm Package Compare versions

Comparing version 2.3.3 to 2.3.4

6

dist/sdk/sdk.js

@@ -37,5 +37,5 @@ "use strict";

this.openapiDocVersion = "1.0.0";
this.sdkVersion = "2.3.3";
this.genVersion = "2.258.0";
this.userAgent = "speakeasy-sdk/typescript 2.3.3 2.258.0 1.0.0 testkube-sdk";
this.sdkVersion = "2.3.4";
this.genVersion = "2.272.4";
this.userAgent = "speakeasy-sdk/typescript 2.3.4 2.272.4 1.0.0 testkube-sdk";
Object.assign(this, init);

@@ -42,0 +42,0 @@ }

14

docs/sdk/models/operations/listlabelsresponse.md

@@ -6,8 +6,8 @@ # ListLabelsResponse

| Field | Type | Required | Description | Example |
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
| `classes` | [shared.Problem](../../../sdk/models/shared/problem.md)[] | :heavy_minus_sign: | problem with read information from kubernetes cluster | |
| `object` | Record<string, *string*[]> | :heavy_minus_sign: | successful operation | {"app":["backend"],"env":["prod"],"toDelete":["yes"]} |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
| `classes` | [shared.Problem](../../../sdk/models/shared/problem.md)[] | :heavy_minus_sign: | problem with read information from kubernetes cluster | |
| `object` | Record<string, *string*[]> | :heavy_minus_sign: | successful operation | {<br/>"app": [<br/>"backend"<br/>],<br/>"env": [<br/>"prod"<br/>],<br/>"toDelete": [<br/>"yes"<br/>]<br/>} |

16

docs/sdk/models/shared/debuginfo.md

@@ -8,9 +8,9 @@ # DebugInfo

| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `apiLogs` | *string*[] | :heavy_minus_sign: | N/A | ["logline1","logline2","logline3"] |
| `clientVersion` | *string* | :heavy_minus_sign: | N/A | 1.4.9 |
| `clusterVersion` | *string* | :heavy_minus_sign: | N/A | v1.23.4 |
| `executionLogs` | Record<string, *string*[]> | :heavy_minus_sign: | N/A | |
| `operatorLogs` | *string*[] | :heavy_minus_sign: | N/A | ["logline1","logline2","logline3"] |
| `serverVersion` | *string* | :heavy_minus_sign: | N/A | v1.4.9 |
| Field | Type | Required | Description | Example |
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
| `apiLogs` | *string*[] | :heavy_minus_sign: | N/A | [<br/>"logline1",<br/>"logline2",<br/>"logline3"<br/>] |
| `clientVersion` | *string* | :heavy_minus_sign: | N/A | 1.4.9 |
| `clusterVersion` | *string* | :heavy_minus_sign: | N/A | v1.23.4 |
| `executionLogs` | Record<string, *string*[]> | :heavy_minus_sign: | N/A | |
| `operatorLogs` | *string*[] | :heavy_minus_sign: | N/A | [<br/>"logline1",<br/>"logline2",<br/>"logline3"<br/>] |
| `serverVersion` | *string* | :heavy_minus_sign: | N/A | v1.4.9 |

12

docs/sdk/models/shared/execution.md

@@ -10,7 +10,7 @@ # Execution

| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `args` | *string*[] | :heavy_minus_sign: | additional arguments/flags passed to executor binary | ["--concurrency","2","--remote","--some","blabla"] |
| `args` | *string*[] | :heavy_minus_sign: | additional arguments/flags passed to executor binary | [<br/>"--concurrency",<br/>"2",<br/>"--remote",<br/>"--some",<br/>"blabla"<br/>] |
| `argsMode` | [shared.ArgsMode](../../../sdk/models/shared/argsmode.md) | :heavy_minus_sign: | usage mode for arguments | |
| `artifactRequest` | [shared.ArtifactRequest](../../../sdk/models/shared/artifactrequest.md) | :heavy_minus_sign: | artifact request body with test artifacts | |
| `bucketName` | *string* | :heavy_minus_sign: | minio bucket name to get uploads from | execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43 |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | ["curl"] |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | [<br/>"curl"<br/>] |
| `content` | [shared.TestContent](../../../sdk/models/shared/testcontent.md) | :heavy_minus_sign: | N/A | |

@@ -20,7 +20,7 @@ | `duration` | *string* | :heavy_minus_sign: | test duration | 88s |

| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | test end time | |
| ~~`envs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Environment variables passed to executor. Deprecated: use Basic Variables instead | {"record":"true","prefix":"some-"} |
| ~~`envs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Environment variables passed to executor. Deprecated: use Basic Variables instead | {<br/>"record": "true",<br/>"prefix": "some-"<br/>} |
| `executionResult` | [shared.ExecutionResult](../../../sdk/models/shared/executionresult.md) | :heavy_minus_sign: | execution result returned from executor | |
| `id` | *string* | :heavy_minus_sign: | execution id | 62f395e004109209b50edfc4 |
| `isVariablesFileUploaded` | *boolean* | :heavy_minus_sign: | in case the variables file is too big, it will be uploaded to storage | false |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test and execution labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test and execution labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_minus_sign: | execution name | test-suite1-example-test-1 |

@@ -38,4 +38,4 @@ | `number` | *number* | :heavy_minus_sign: | execution number | 1 |

| `testType` | *string* | :heavy_minus_sign: | test type e.g. postman/collection | postman/collection |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that need to be copied into the test from uploads | ["settings/config.txt"] |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {"var1":{"name":"var1","type":"basic","value":"value1"},"secret1":{"name":"secret1","type":"secret","value":"secretvalue1"}} |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that need to be copied into the test from uploads | [<br/>"settings/config.txt"<br/>] |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {<br/>"var1": {<br/>"name": "var1",<br/>"type": "basic",<br/>"value": "value1"<br/>},<br/>"secret1": {<br/>"name": "secret1",<br/>"type": "secret",<br/>"value": "secretvalue1"<br/>}<br/>} |
| `variablesFile` | *string* | :heavy_minus_sign: | variables file content - need to be in format for particular executor (e.g. postman envs file) | |

14

docs/sdk/models/shared/executionrequest.md

@@ -11,7 +11,7 @@ # ExecutionRequest

| `activeDeadlineSeconds` | *number* | :heavy_minus_sign: | duration in seconds the test may be active, until its stopped | 1 |
| `args` | *string*[] | :heavy_minus_sign: | additional executor binary arguments | ["--repeats","5","--insecure"] |
| `args` | *string*[] | :heavy_minus_sign: | additional executor binary arguments | [<br/>"--repeats",<br/>"5",<br/>"--insecure"<br/>] |
| `argsMode` | [shared.ExecutionRequestArgsMode](../../../sdk/models/shared/executionrequestargsmode.md) | :heavy_minus_sign: | usage mode for arguments | |
| `artifactRequest` | [shared.ArtifactRequest](../../../sdk/models/shared/artifactrequest.md) | :heavy_minus_sign: | artifact request body with test artifacts | |
| `bucketName` | *string* | :heavy_minus_sign: | minio bucket name to get uploads from | execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43 |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | ["curl"] |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | [<br/>"curl"<br/>] |
| `contentRequest` | [shared.TestContentRequest](../../../sdk/models/shared/testcontentrequest.md) | :heavy_minus_sign: | test content request body | |

@@ -21,4 +21,4 @@ | `cronJobTemplate` | *string* | :heavy_minus_sign: | cron job template extensions | |

| `envSecrets` | [shared.EnvReference](../../../sdk/models/shared/envreference.md)[] | :heavy_minus_sign: | secret references | |
| ~~`envs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Environment variables passed to executor. Deprecated: use Basic Variables instead | {"record":"true","prefix":"some-"} |
| `executionLabels` | Record<string, *string*> | :heavy_minus_sign: | test execution labels | {"users":"3","prefix":"some-"} |
| ~~`envs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Environment variables passed to executor. Deprecated: use Basic Variables instead | {<br/>"record": "true",<br/>"prefix": "some-"<br/>} |
| `executionLabels` | Record<string, *string*> | :heavy_minus_sign: | test execution labels | {<br/>"users": "3",<br/>"prefix": "some-"<br/>} |
| `httpProxy` | *string* | :heavy_minus_sign: | http proxy for executor containers | user:pass@my.proxy.server:8080 |

@@ -40,3 +40,3 @@ | `httpsProxy` | *string* | :heavy_minus_sign: | https proxy for executor containers | user:pass@my.proxy.server:8081 |

| `scraperTemplate` | *string* | :heavy_minus_sign: | scraper template extensions | |
| ~~`secretEnvs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Execution variables passed to executor from secrets. Deprecated: use Secret Variables instead | {"secret_key_name1":"secret-name","secret_Key_name2":"secret-name"} |
| ~~`secretEnvs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Execution variables passed to executor from secrets. Deprecated: use Secret Variables instead | {<br/>"secret_key_name1": "secret-name",<br/>"secret_Key_name2": "secret-name"<br/>} |
| `sync` | *boolean* | :heavy_minus_sign: | whether to start execution sync or async | |

@@ -46,4 +46,4 @@ | `testSecretUUID` | *string* | :heavy_minus_sign: | test secret uuid | 7934600f-b367-48dd-b981-4353304362fb |

| `testSuiteSecretUUID` | *string* | :heavy_minus_sign: | test suite secret uuid, if it's run as a part of test suite | 7934600f-b367-48dd-b981-4353304362fb |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that need to be copied into the test from uploads | ["settings/config.txt"] |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {"var1":{"name":"var1","type":"basic","value":"value1"},"secret1":{"name":"secret1","type":"secret","value":"secretvalue1"}} |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that need to be copied into the test from uploads | [<br/>"settings/config.txt"<br/>] |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {<br/>"var1": {<br/>"name": "var1",<br/>"type": "basic",<br/>"value": "value1"<br/>},<br/>"secret1": {<br/>"name": "secret1",<br/>"type": "secret",<br/>"value": "secretvalue1"<br/>}<br/>} |
| `variablesFile` | *string* | :heavy_minus_sign: | variables file content - need to be in format for particular executor (e.g. postman envs file) | |

14

docs/sdk/models/shared/executionrequestinput.md

@@ -11,7 +11,7 @@ # ExecutionRequestInput

| `activeDeadlineSeconds` | *number* | :heavy_minus_sign: | duration in seconds the test may be active, until its stopped | 1 |
| `args` | *string*[] | :heavy_minus_sign: | additional executor binary arguments | ["--repeats","5","--insecure"] |
| `args` | *string*[] | :heavy_minus_sign: | additional executor binary arguments | [<br/>"--repeats",<br/>"5",<br/>"--insecure"<br/>] |
| `argsMode` | [shared.ExecutionRequestArgsMode](../../../sdk/models/shared/executionrequestargsmode.md) | :heavy_minus_sign: | usage mode for arguments | |
| `artifactRequest` | [shared.ArtifactRequest](../../../sdk/models/shared/artifactrequest.md) | :heavy_minus_sign: | artifact request body with test artifacts | |
| `bucketName` | *string* | :heavy_minus_sign: | minio bucket name to get uploads from | execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43 |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | ["curl"] |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | [<br/>"curl"<br/>] |
| `contentRequest` | [shared.TestContentRequest](../../../sdk/models/shared/testcontentrequest.md) | :heavy_minus_sign: | test content request body | |

@@ -21,4 +21,4 @@ | `cronJobTemplate` | *string* | :heavy_minus_sign: | cron job template extensions | |

| `envSecrets` | [shared.EnvReference](../../../sdk/models/shared/envreference.md)[] | :heavy_minus_sign: | secret references | |
| ~~`envs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Environment variables passed to executor. Deprecated: use Basic Variables instead | {"record":"true","prefix":"some-"} |
| `executionLabels` | Record<string, *string*> | :heavy_minus_sign: | test execution labels | {"users":"3","prefix":"some-"} |
| ~~`envs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Environment variables passed to executor. Deprecated: use Basic Variables instead | {<br/>"record": "true",<br/>"prefix": "some-"<br/>} |
| `executionLabels` | Record<string, *string*> | :heavy_minus_sign: | test execution labels | {<br/>"users": "3",<br/>"prefix": "some-"<br/>} |
| `httpProxy` | *string* | :heavy_minus_sign: | http proxy for executor containers | user:pass@my.proxy.server:8080 |

@@ -40,7 +40,7 @@ | `httpsProxy` | *string* | :heavy_minus_sign: | https proxy for executor containers | user:pass@my.proxy.server:8081 |

| `scraperTemplate` | *string* | :heavy_minus_sign: | scraper template extensions | |
| ~~`secretEnvs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Execution variables passed to executor from secrets. Deprecated: use Secret Variables instead | {"secret_key_name1":"secret-name","secret_Key_name2":"secret-name"} |
| ~~`secretEnvs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Execution variables passed to executor from secrets. Deprecated: use Secret Variables instead | {<br/>"secret_key_name1": "secret-name",<br/>"secret_Key_name2": "secret-name"<br/>} |
| `sync` | *boolean* | :heavy_minus_sign: | whether to start execution sync or async | |
| `testSuiteName` | *string* | :heavy_minus_sign: | unique test suite name (CRD Test suite name), if it's run as a part of test suite | test-suite1 |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that need to be copied into the test from uploads | ["settings/config.txt"] |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {"var1":{"name":"var1","type":"basic","value":"value1"},"secret1":{"name":"secret1","type":"secret","value":"secretvalue1"}} |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that need to be copied into the test from uploads | [<br/>"settings/config.txt"<br/>] |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {<br/>"var1": {<br/>"name": "var1",<br/>"type": "basic",<br/>"value": "value1"<br/>},<br/>"secret1": {<br/>"name": "secret1",<br/>"type": "secret",<br/>"value": "secretvalue1"<br/>}<br/>} |
| `variablesFile` | *string* | :heavy_minus_sign: | variables file content - need to be in format for particular executor (e.g. postman envs file) | |

2

docs/sdk/models/shared/executionsummary.md

@@ -14,3 +14,3 @@ # ExecutionSummary

| `id` | *string* | :heavy_check_mark: | execution id | 62f395e004109209b50edfc4 |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test and execution labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test and execution labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_check_mark: | execution name | test-suite1-test1 |

@@ -17,0 +17,0 @@ | `number` | *number* | :heavy_minus_sign: | execution number | 1 |

6

docs/sdk/models/shared/executor.md

@@ -10,4 +10,4 @@ # Executor

| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `args` | *string*[] | :heavy_minus_sign: | additional executor binary argument | ["--repeats","5","--insecure"] |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | ["curl"] |
| `args` | *string*[] | :heavy_minus_sign: | additional executor binary argument | [<br/>"--repeats",<br/>"5",<br/>"--insecure"<br/>] |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | [<br/>"curl"<br/>] |
| `contentTypes` | *string*[] | :heavy_minus_sign: | list of handled content types | |

@@ -19,5 +19,5 @@ | `executorType` | *string* | :heavy_minus_sign: | ExecutorType one of "rest" for rest openapi based executors or "job" which will be default runners for testkube soon | |

| `jobTemplate` | *string* | :heavy_minus_sign: | Job template to launch executor | |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | executor labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | executor labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `meta` | [shared.ExecutorMeta](../../../sdk/models/shared/executormeta.md) | :heavy_minus_sign: | Executor meta data | |
| `types` | *string*[] | :heavy_minus_sign: | Types defines what types can be handled by executor e.g. "postman/collection", ":curl/command" etc | |
| `uri` | *string* | :heavy_minus_sign: | URI for rest based executors | |

10

docs/sdk/models/shared/executormeta.md

@@ -8,6 +8,6 @@ # ExecutorMeta

| Field | Type | Required | Description | Example |
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
| `docsURI` | *string* | :heavy_minus_sign: | URI for executor docs | https://docs.testkube.io/test-types/executor-k6 |
| `iconURI` | *string* | :heavy_minus_sign: | URI for executor icon | /assets/k6.jpg |
| `tooltips` | Record<string, *string*> | :heavy_minus_sign: | executor tooltips | {"general":"please provide k6 test script for execution"} |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `docsURI` | *string* | :heavy_minus_sign: | URI for executor docs | https://docs.testkube.io/test-types/executor-k6 |
| `iconURI` | *string* | :heavy_minus_sign: | URI for executor icon | /assets/k6.jpg |
| `tooltips` | Record<string, *string*> | :heavy_minus_sign: | executor tooltips | {<br/>"general": "please provide k6 test script for execution"<br/>} |

6

docs/sdk/models/shared/executorupdaterequest.md

@@ -10,4 +10,4 @@ # ExecutorUpdateRequest

| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `args` | *string*[] | :heavy_minus_sign: | additional executor binary argument | ["--repeats","5","--insecure"] |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | ["curl"] |
| `args` | *string*[] | :heavy_minus_sign: | additional executor binary argument | [<br/>"--repeats",<br/>"5",<br/>"--insecure"<br/>] |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | [<br/>"curl"<br/>] |
| `contentTypes` | *string*[] | :heavy_minus_sign: | list of handled content types | |

@@ -19,3 +19,3 @@ | `executorType` | *string* | :heavy_minus_sign: | ExecutorType one of "rest" for rest openapi based executors or "job" which will be default runners for testkube soon | |

| `jobTemplate` | *string* | :heavy_minus_sign: | Job template to launch executor | |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | executor labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | executor labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `meta` | [shared.ExecutorMeta](../../../sdk/models/shared/executormeta.md) | :heavy_minus_sign: | Executor meta data | |

@@ -22,0 +22,0 @@ | `name` | *string* | :heavy_check_mark: | object name | name |

6

docs/sdk/models/shared/executorupsertrequest.md

@@ -10,4 +10,4 @@ # ExecutorUpsertRequest

| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `args` | *string*[] | :heavy_minus_sign: | additional executor binary argument | ["--repeats","5","--insecure"] |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | ["curl"] |
| `args` | *string*[] | :heavy_minus_sign: | additional executor binary argument | [<br/>"--repeats",<br/>"5",<br/>"--insecure"<br/>] |
| `command` | *string*[] | :heavy_minus_sign: | executor image command | [<br/>"curl"<br/>] |
| `contentTypes` | *string*[] | :heavy_minus_sign: | list of handled content types | |

@@ -19,3 +19,3 @@ | `executorType` | *string* | :heavy_minus_sign: | ExecutorType one of "rest" for rest openapi based executors or "job" which will be default runners for testkube soon | |

| `jobTemplate` | *string* | :heavy_minus_sign: | Job template to launch executor | |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | executor labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | executor labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `meta` | [shared.ExecutorMeta](../../../sdk/models/shared/executormeta.md) | :heavy_minus_sign: | Executor meta data | |

@@ -22,0 +22,0 @@ | `name` | *string* | :heavy_check_mark: | object name | name |

4

docs/sdk/models/shared/test.md

@@ -11,3 +11,3 @@ # Test

| `executionRequest` | [shared.ExecutionRequest](../../../sdk/models/shared/executionrequest.md) | :heavy_minus_sign: | test execution request body | |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_minus_sign: | test name | test1 |

@@ -19,2 +19,2 @@ | `namespace` | *string* | :heavy_minus_sign: | test namespace | testkube |

| `type` | *string* | :heavy_minus_sign: | test type | postman/collection |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that will be needed from uploads | ["settings/config.txt"] |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that will be needed from uploads | [<br/>"settings/config.txt"<br/>] |

10

docs/sdk/models/shared/testsourcebatchresult.md

@@ -8,6 +8,6 @@ # TestSourceBatchResult

| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `created` | *string*[] | :heavy_minus_sign: | created test sources | ["name1","name2","name3"] |
| `deleted` | *string*[] | :heavy_minus_sign: | deleted test sources | ["name7","name8","name9"] |
| `updated` | *string*[] | :heavy_minus_sign: | updated test sources | ["name4","name5","name6"] |
| Field | Type | Required | Description | Example |
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
| `created` | *string*[] | :heavy_minus_sign: | created test sources | [<br/>"name1",<br/>"name2",<br/>"name3"<br/>] |
| `deleted` | *string*[] | :heavy_minus_sign: | deleted test sources | [<br/>"name7",<br/>"name8",<br/>"name9"<br/>] |
| `updated` | *string*[] | :heavy_minus_sign: | updated test sources | [<br/>"name4",<br/>"name5",<br/>"name6"<br/>] |

8

docs/sdk/models/shared/testsuite.md

@@ -8,8 +8,8 @@ # TestSuite

| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `after` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps after whole suite | [{"execute":[{"test":"example-test"}],"stopOnFailure":true}] |
| `before` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps before whole suite | [{"execute":[{"test":"example-test"}],"stopOnFailure":true}] |
| `after` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps after whole suite | [<br/>{<br/>"stopOnFailure": true,<br/>"execute": [<br/>{<br/>"test": "example-test"<br/>}<br/>]<br/>}<br/>] |
| `before` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps before whole suite | [<br/>{<br/>"stopOnFailure": true,<br/>"execute": [<br/>{<br/>"test": "example-test"<br/>}<br/>]<br/>}<br/>] |
| `created` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | |
| `description` | *string* | :heavy_minus_sign: | N/A | collection of tests |
| `executionRequest` | [shared.TestSuiteExecutionRequest](../../../sdk/models/shared/testsuiteexecutionrequest.md) | :heavy_minus_sign: | test suite execution request body | |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_check_mark: | N/A | test-suite1 |

@@ -20,2 +20,2 @@ | `namespace` | *string* | :heavy_minus_sign: | N/A | testkube |

| `status` | [shared.TestSuiteStatus](../../../sdk/models/shared/testsuitestatus.md) | :heavy_check_mark: | test suite status | |
| `steps` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Batch steps to run | [{"execute":[{"test":"example-test"}],"stopOnFailure":true}] |
| `steps` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Batch steps to run | [<br/>{<br/>"stopOnFailure": true,<br/>"execute": [<br/>{<br/>"test": "example-test"<br/>}<br/>]<br/>}<br/>] |

6

docs/sdk/models/shared/testsuiteexecution.md

@@ -13,6 +13,6 @@ # TestSuiteExecution

| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | test end time | |
| ~~`envs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Environment variables passed to executor. Deprecated: use Basic Variables instead | {"record":"true","prefix":"some-"} |
| ~~`envs`~~ | Record<string, *string*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Environment variables passed to executor. Deprecated: use Basic Variables instead | {<br/>"record": "true",<br/>"prefix": "some-"<br/>} |
| `executeStepResults` | [shared.TestSuiteBatchStepExecutionResult](../../../sdk/models/shared/testsuitebatchstepexecutionresult.md)[] | :heavy_minus_sign: | batch steps execution results | |
| `id` | *string* | :heavy_check_mark: | execution id | 62f395e004109209b50edfc1 |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_check_mark: | execution name | test-suite1.needlessly-sweet-imp |

@@ -25,2 +25,2 @@ | `runningContext` | [shared.RunningContext](../../../sdk/models/shared/runningcontext.md) | :heavy_minus_sign: | running context for test or test suite execution | |

| `testSuite` | [shared.ObjectRef](../../../sdk/models/shared/objectref.md) | :heavy_check_mark: | N/A | |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {"var1":{"name":"var1","type":"basic","value":"value1"},"secret1":{"name":"secret1","type":"secret","value":"secretvalue1"}} |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {<br/>"var1": {<br/>"name": "var1",<br/>"type": "basic",<br/>"value": "value1"<br/>},<br/>"secret1": {<br/>"name": "secret1",<br/>"type": "secret",<br/>"value": "secretvalue1"<br/>}<br/>} |

34

docs/sdk/models/shared/testsuiteexecutionrequest.md

@@ -8,18 +8,18 @@ # TestSuiteExecutionRequest

| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `concurrencyLevel` | *number* | :heavy_minus_sign: | number of tests run in parallel | 10 |
| `contentRequest` | [shared.TestContentRequest](../../../sdk/models/shared/testcontentrequest.md) | :heavy_minus_sign: | test content request body | |
| `cronJobTemplate` | *string* | :heavy_minus_sign: | cron job template extensions | |
| `executionLabels` | Record<string, *string*> | :heavy_minus_sign: | execution labels | {"users":"3","prefix":"some-"} |
| `httpProxy` | *string* | :heavy_minus_sign: | http proxy for executor containers | user:pass@my.proxy.server:8080 |
| `httpsProxy` | *string* | :heavy_minus_sign: | https proxy for executor containers | user:pass@my.proxy.server:8081 |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {"users":"3","prefix":"some-"} |
| `name` | *string* | :heavy_minus_sign: | test execution custom name | testing with 1000 users |
| `namespace` | *string* | :heavy_minus_sign: | test kubernetes namespace ("testkube" when not set) | testkube |
| `number` | *number* | :heavy_minus_sign: | test suite execution number | 1 |
| `runningContext` | [shared.RunningContext](../../../sdk/models/shared/runningcontext.md) | :heavy_minus_sign: | running context for test or test suite execution | |
| `secretUUID` | *string* | :heavy_minus_sign: | secret uuid | 7934600f-b367-48dd-b981-4353304362fb |
| `sync` | *boolean* | :heavy_minus_sign: | whether to start execution sync or async | |
| `timeout` | *number* | :heavy_minus_sign: | duration in seconds the test suite may be active, until its stopped | 1 |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {"var1":{"name":"var1","type":"basic","value":"value1"},"secret1":{"name":"secret1","type":"secret","value":"secretvalue1"}} |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `concurrencyLevel` | *number* | :heavy_minus_sign: | number of tests run in parallel | 10 |
| `contentRequest` | [shared.TestContentRequest](../../../sdk/models/shared/testcontentrequest.md) | :heavy_minus_sign: | test content request body | |
| `cronJobTemplate` | *string* | :heavy_minus_sign: | cron job template extensions | |
| `executionLabels` | Record<string, *string*> | :heavy_minus_sign: | execution labels | {<br/>"users": "3",<br/>"prefix": "some-"<br/>} |
| `httpProxy` | *string* | :heavy_minus_sign: | http proxy for executor containers | user:pass@my.proxy.server:8080 |
| `httpsProxy` | *string* | :heavy_minus_sign: | https proxy for executor containers | user:pass@my.proxy.server:8081 |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {<br/>"users": "3",<br/>"prefix": "some-"<br/>} |
| `name` | *string* | :heavy_minus_sign: | test execution custom name | testing with 1000 users |
| `namespace` | *string* | :heavy_minus_sign: | test kubernetes namespace ("testkube" when not set) | testkube |
| `number` | *number* | :heavy_minus_sign: | test suite execution number | 1 |
| `runningContext` | [shared.RunningContext](../../../sdk/models/shared/runningcontext.md) | :heavy_minus_sign: | running context for test or test suite execution | |
| `secretUUID` | *string* | :heavy_minus_sign: | secret uuid | 7934600f-b367-48dd-b981-4353304362fb |
| `sync` | *boolean* | :heavy_minus_sign: | whether to start execution sync or async | |
| `timeout` | *number* | :heavy_minus_sign: | duration in seconds the test suite may be active, until its stopped | 1 |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {<br/>"var1": {<br/>"name": "var1",<br/>"type": "basic",<br/>"value": "value1"<br/>},<br/>"secret1": {<br/>"name": "secret1",<br/>"type": "secret",<br/>"value": "secretvalue1"<br/>}<br/>} |

32

docs/sdk/models/shared/testsuiteexecutionrequestinput.md

@@ -8,17 +8,17 @@ # TestSuiteExecutionRequestInput

| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `concurrencyLevel` | *number* | :heavy_minus_sign: | number of tests run in parallel | 10 |
| `contentRequest` | [shared.TestContentRequest](../../../sdk/models/shared/testcontentrequest.md) | :heavy_minus_sign: | test content request body | |
| `cronJobTemplate` | *string* | :heavy_minus_sign: | cron job template extensions | |
| `executionLabels` | Record<string, *string*> | :heavy_minus_sign: | execution labels | {"users":"3","prefix":"some-"} |
| `httpProxy` | *string* | :heavy_minus_sign: | http proxy for executor containers | user:pass@my.proxy.server:8080 |
| `httpsProxy` | *string* | :heavy_minus_sign: | https proxy for executor containers | user:pass@my.proxy.server:8081 |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {"users":"3","prefix":"some-"} |
| `name` | *string* | :heavy_minus_sign: | test execution custom name | testing with 1000 users |
| `namespace` | *string* | :heavy_minus_sign: | test kubernetes namespace ("testkube" when not set) | testkube |
| `number` | *number* | :heavy_minus_sign: | test suite execution number | 1 |
| `runningContext` | [shared.RunningContext](../../../sdk/models/shared/runningcontext.md) | :heavy_minus_sign: | running context for test or test suite execution | |
| `sync` | *boolean* | :heavy_minus_sign: | whether to start execution sync or async | |
| `timeout` | *number* | :heavy_minus_sign: | duration in seconds the test suite may be active, until its stopped | 1 |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {"var1":{"name":"var1","type":"basic","value":"value1"},"secret1":{"name":"secret1","type":"secret","value":"secretvalue1"}} |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `concurrencyLevel` | *number* | :heavy_minus_sign: | number of tests run in parallel | 10 |
| `contentRequest` | [shared.TestContentRequest](../../../sdk/models/shared/testcontentrequest.md) | :heavy_minus_sign: | test content request body | |
| `cronJobTemplate` | *string* | :heavy_minus_sign: | cron job template extensions | |
| `executionLabels` | Record<string, *string*> | :heavy_minus_sign: | execution labels | {<br/>"users": "3",<br/>"prefix": "some-"<br/>} |
| `httpProxy` | *string* | :heavy_minus_sign: | http proxy for executor containers | user:pass@my.proxy.server:8080 |
| `httpsProxy` | *string* | :heavy_minus_sign: | https proxy for executor containers | user:pass@my.proxy.server:8081 |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {<br/>"users": "3",<br/>"prefix": "some-"<br/>} |
| `name` | *string* | :heavy_minus_sign: | test execution custom name | testing with 1000 users |
| `namespace` | *string* | :heavy_minus_sign: | test kubernetes namespace ("testkube" when not set) | testkube |
| `number` | *number* | :heavy_minus_sign: | test suite execution number | 1 |
| `runningContext` | [shared.RunningContext](../../../sdk/models/shared/runningcontext.md) | :heavy_minus_sign: | running context for test or test suite execution | |
| `sync` | *boolean* | :heavy_minus_sign: | whether to start execution sync or async | |
| `timeout` | *number* | :heavy_minus_sign: | duration in seconds the test suite may be active, until its stopped | 1 |
| `variables` | Record<string, [shared.Variable](../../../sdk/models/shared/variable.md)> | :heavy_minus_sign: | execution variables passed to executor converted to vars for usage in tests | {<br/>"var1": {<br/>"name": "var1",<br/>"type": "basic",<br/>"value": "value1"<br/>},<br/>"secret1": {<br/>"name": "secret1",<br/>"type": "secret",<br/>"value": "secretvalue1"<br/>}<br/>} |

2

docs/sdk/models/shared/testsuiteexecutionsummary.md

@@ -15,3 +15,3 @@ # TestSuiteExecutionSummary

| `id` | *string* | :heavy_check_mark: | execution id | 62f395e004109209b50edfc1 |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite and execution labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite and execution labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_check_mark: | execution name | test-suite1.needlessly-sweet-imp |

@@ -18,0 +18,0 @@ | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | test suite execution start time | |

8

docs/sdk/models/shared/testsuiteupdaterequest.md

@@ -10,8 +10,8 @@ # TestSuiteUpdateRequest

| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `after` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps after whole suite | [{"execute":[{"test":"example-test"}],"stopOnFailure":true}] |
| `before` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps before whole suite | [{"execute":[{"test":"example-test"}],"stopOnFailure":true}] |
| `after` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps after whole suite | [<br/>{<br/>"stopOnFailure": true,<br/>"execute": [<br/>{<br/>"test": "example-test"<br/>}<br/>]<br/>}<br/>] |
| `before` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps before whole suite | [<br/>{<br/>"stopOnFailure": true,<br/>"execute": [<br/>{<br/>"test": "example-test"<br/>}<br/>]<br/>}<br/>] |
| `created` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | |
| `description` | *string* | :heavy_minus_sign: | N/A | collection of tests |
| `executionRequest` | [shared.TestSuiteExecutionRequestInput](../../../sdk/models/shared/testsuiteexecutionrequestinput.md) | :heavy_minus_sign: | test suite execution request body | |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_check_mark: | object name | name |

@@ -22,2 +22,2 @@ | `namespace` | *string* | :heavy_minus_sign: | object kubernetes namespace | testkube |

| `status` | [shared.TestSuiteStatus](../../../sdk/models/shared/testsuitestatus.md) | :heavy_check_mark: | test suite status | |
| `steps` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Batch steps to run | [{"execute":[{"test":"example-test"}],"stopOnFailure":true}] |
| `steps` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Batch steps to run | [<br/>{<br/>"stopOnFailure": true,<br/>"execute": [<br/>{<br/>"test": "example-test"<br/>}<br/>]<br/>}<br/>] |

8

docs/sdk/models/shared/testsuiteupsertrequest.md

@@ -10,8 +10,8 @@ # TestSuiteUpsertRequest

| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `after` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps after whole suite | [{"execute":[{"test":"example-test"}],"stopOnFailure":true}] |
| `before` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps before whole suite | [{"execute":[{"test":"example-test"}],"stopOnFailure":true}] |
| `after` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps after whole suite | [<br/>{<br/>"stopOnFailure": true,<br/>"execute": [<br/>{<br/>"test": "example-test"<br/>}<br/>]<br/>}<br/>] |
| `before` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Run these batch steps before whole suite | [<br/>{<br/>"stopOnFailure": true,<br/>"execute": [<br/>{<br/>"test": "example-test"<br/>}<br/>]<br/>}<br/>] |
| `created` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | |
| `description` | *string* | :heavy_minus_sign: | N/A | collection of tests |
| `executionRequest` | [shared.TestSuiteExecutionRequestInput](../../../sdk/models/shared/testsuiteexecutionrequestinput.md) | :heavy_minus_sign: | test suite execution request body | |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test suite labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_check_mark: | object name | name |

@@ -22,2 +22,2 @@ | `namespace` | *string* | :heavy_check_mark: | object kubernetes namespace | testkube |

| `status` | [shared.TestSuiteStatus](../../../sdk/models/shared/testsuitestatus.md) | :heavy_check_mark: | test suite status | |
| `steps` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Batch steps to run | [{"execute":[{"test":"example-test"}],"stopOnFailure":true}] |
| `steps` | [shared.TestSuiteBatchStep](../../../sdk/models/shared/testsuitebatchstep.md)[] | :heavy_minus_sign: | Batch steps to run | [<br/>{<br/>"stopOnFailure": true,<br/>"execute": [<br/>{<br/>"test": "example-test"<br/>}<br/>]<br/>}<br/>] |

2

docs/sdk/models/shared/testtrigger.md

@@ -12,3 +12,3 @@ # TestTrigger

| `execution` | [shared.TestTriggerExecutions](../../../sdk/models/shared/testtriggerexecutions.md) | :heavy_check_mark: | supported test resources for test triggers | |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test trigger labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test trigger labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_minus_sign: | test trigger name | test1 |

@@ -15,0 +15,0 @@ | `namespace` | *string* | :heavy_minus_sign: | test trigger namespace | testkube |

14

docs/sdk/models/shared/testtriggerkeymap.md

@@ -6,8 +6,8 @@ # TestTriggerKeyMap

| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `actions` | *string*[] | :heavy_check_mark: | list of supported values for resources | ["run"] |
| `conditions` | *string*[] | :heavy_minus_sign: | list of supported values for conditions | ["Available","Progressing"] |
| `events` | Record<string, *string*[]> | :heavy_check_mark: | mapping between resources and supported events | {"pod":["created","modified","deleted"],"deployment":["created","modified","deleted"]} |
| `executions` | *string*[] | :heavy_check_mark: | list of supported values for resources | ["test","testsuite"] |
| `resources` | *string*[] | :heavy_check_mark: | list of supported values for resources | ["pod","deployment","statefulset","daemonset","service","ingress","event","configmap"] |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `actions` | *string*[] | :heavy_check_mark: | list of supported values for resources | [<br/>"run"<br/>] |
| `conditions` | *string*[] | :heavy_minus_sign: | list of supported values for conditions | [<br/>"Available",<br/>"Progressing"<br/>] |
| `events` | Record<string, *string*[]> | :heavy_check_mark: | mapping between resources and supported events | {<br/>"pod": [<br/>"created",<br/>"modified",<br/>"deleted"<br/>],<br/>"deployment": [<br/>"created",<br/>"modified",<br/>"deleted"<br/>]<br/>} |
| `executions` | *string*[] | :heavy_check_mark: | list of supported values for resources | [<br/>"test",<br/>"testsuite"<br/>] |
| `resources` | *string*[] | :heavy_check_mark: | list of supported values for resources | [<br/>"pod",<br/>"deployment",<br/>"statefulset",<br/>"daemonset",<br/>"service",<br/>"ingress",<br/>"event",<br/>"configmap"<br/>] |

2

docs/sdk/models/shared/testtriggerprobe.md

@@ -10,3 +10,3 @@ # TestTriggerProbe

| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `headers` | Record<string, *string*> | :heavy_minus_sign: | test trigger condition probe headers to submit | {"Content-Type":"application/xml"} |
| `headers` | Record<string, *string*> | :heavy_minus_sign: | test trigger condition probe headers to submit | {<br/>"Content-Type": "application/xml"<br/>} |
| `host` | *string* | :heavy_minus_sign: | test trigger condition probe host, default is pod ip or service name | testkube-api-server |

@@ -13,0 +13,0 @@ | `path` | *string* | :heavy_minus_sign: | test trigger condition probe path to check, default is / | / |

2

docs/sdk/models/shared/testtriggerupsertrequest.md

@@ -14,3 +14,3 @@ # TestTriggerUpsertRequest

| `execution` | [shared.TestTriggerExecutions](../../../sdk/models/shared/testtriggerexecutions.md) | :heavy_check_mark: | supported test resources for test triggers | |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test trigger labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test trigger labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_check_mark: | object name | name |

@@ -17,0 +17,0 @@ | `namespace` | *string* | :heavy_minus_sign: | object kubernetes namespace | testkube |

4

docs/sdk/models/shared/testupdaterequest.md

@@ -13,3 +13,3 @@ # TestUpdateRequest

| `executionRequest` | [shared.ExecutionRequestInput](../../../sdk/models/shared/executionrequestinput.md) | :heavy_minus_sign: | test execution request body | |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_minus_sign: | test name | test1 |

@@ -21,2 +21,2 @@ | `namespace` | *string* | :heavy_minus_sign: | test namespace | testkube |

| `type` | *string* | :heavy_minus_sign: | test type | postman/collection |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that will be needed from uploads | ["settings/config.txt"] |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that will be needed from uploads | [<br/>"settings/config.txt"<br/>] |

4

docs/sdk/models/shared/testupsertrequest.md

@@ -13,3 +13,3 @@ # TestUpsertRequest

| `executionRequest` | [shared.ExecutionRequestInput](../../../sdk/models/shared/executionrequestinput.md) | :heavy_minus_sign: | test execution request body | |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test labels | {"env":"prod","app":"backend"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | test labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_minus_sign: | test name | test1 |

@@ -21,2 +21,2 @@ | `namespace` | *string* | :heavy_minus_sign: | test namespace | testkube |

| `type` | *string* | :heavy_minus_sign: | test type | postman/collection |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that will be needed from uploads | ["settings/config.txt"] |
| `uploads` | *string*[] | :heavy_minus_sign: | list of file paths that will be needed from uploads | [<br/>"settings/config.txt"<br/>] |

4

docs/sdk/models/shared/webhook.md

@@ -11,4 +11,4 @@ # Webhook

| `events` | [shared.EventType](../../../sdk/models/shared/eventtype.md)[] | :heavy_check_mark: | N/A | |
| `headers` | Record<string, *string*> | :heavy_minus_sign: | webhook headers | {"Content-Type":"application/xml"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | webhook labels | {"env":"prod","app":"backend"} |
| `headers` | Record<string, *string*> | :heavy_minus_sign: | webhook headers | {<br/>"Content-Type": "application/xml"<br/>} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | webhook labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_minus_sign: | N/A | webhook1 |

@@ -15,0 +15,0 @@ | `namespace` | *string* | :heavy_minus_sign: | N/A | testkube |

4

docs/sdk/models/shared/webhookcreaterequest.md

@@ -11,4 +11,4 @@ # WebhookCreateRequest

| `events` | [shared.EventType](../../../sdk/models/shared/eventtype.md)[] | :heavy_check_mark: | N/A | |
| `headers` | Record<string, *string*> | :heavy_minus_sign: | webhook headers | {"Content-Type":"application/xml"} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | webhook labels | {"env":"prod","app":"backend"} |
| `headers` | Record<string, *string*> | :heavy_minus_sign: | webhook headers | {<br/>"Content-Type": "application/xml"<br/>} |
| `labels` | Record<string, *string*> | :heavy_minus_sign: | webhook labels | {<br/>"env": "prod",<br/>"app": "backend"<br/>} |
| `name` | *string* | :heavy_minus_sign: | N/A | webhook1 |

@@ -15,0 +15,0 @@ | `namespace` | *string* | :heavy_minus_sign: | N/A | testkube |

2

package.json
{
"name": "testkube-sdk",
"version": "2.3.3",
"version": "2.3.4",
"author": "aabedraba",

@@ -5,0 +5,0 @@ "scripts": {

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc