@cosmotech/api-ts 4.0.0-dev9 → 5.0.0-beta4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +96 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/LICENSE +1 -1
- package/README.md +212 -2
- package/api.ts +4896 -4560
- package/base.ts +2 -2
- package/common.ts +1 -1
- package/configuration.ts +7 -2
- package/dist/api.d.ts +3303 -2892
- package/dist/api.js +4182 -4367
- package/dist/base.d.ts +1 -1
- package/dist/base.js +2 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +14 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AboutInfo.md +21 -0
- package/docs/AboutInfoVersion.md +33 -0
- package/docs/ComponentRolePermissions.md +23 -0
- package/docs/ContainerResourceSizeInfo.md +23 -0
- package/docs/ContainerResourceSizing.md +23 -0
- package/docs/CreateInfo.md +24 -0
- package/docs/CreatedRun.md +21 -0
- package/docs/Dataset.md +39 -0
- package/docs/DatasetAccessControl.md +23 -0
- package/docs/DatasetApi.md +1289 -0
- package/docs/DatasetCreateRequest.md +31 -0
- package/docs/DatasetPart.md +41 -0
- package/docs/DatasetPartCreateRequest.md +29 -0
- package/docs/DatasetPartTypeEnum.md +11 -0
- package/docs/DatasetPartUpdateRequest.md +25 -0
- package/docs/DatasetRole.md +21 -0
- package/docs/DatasetSecurity.md +23 -0
- package/docs/DatasetUpdateRequest.md +29 -0
- package/docs/EditInfo.md +22 -0
- package/docs/LastRunInfo.md +23 -0
- package/docs/MetaApi.md +51 -0
- package/docs/Organization.md +29 -0
- package/docs/OrganizationAccessControl.md +23 -0
- package/docs/OrganizationApi.md +758 -0
- package/docs/OrganizationCreateRequest.md +23 -0
- package/docs/OrganizationEditInfo.md +22 -0
- package/docs/OrganizationRole.md +21 -0
- package/docs/OrganizationSecurity.md +23 -0
- package/docs/OrganizationUpdateRequest.md +21 -0
- package/docs/QueryResult.md +21 -0
- package/docs/ResourceSizeInfo.md +23 -0
- package/docs/Run.md +55 -0
- package/docs/RunApi.md +442 -0
- package/docs/RunContainer.md +41 -0
- package/docs/RunData.md +25 -0
- package/docs/RunDataQuery.md +21 -0
- package/docs/RunEditInfo.md +22 -0
- package/docs/RunResourceRequested.md +23 -0
- package/docs/RunState.md +17 -0
- package/docs/RunStatus.md +49 -0
- package/docs/RunStatusNode.md +43 -0
- package/docs/RunTemplate.md +37 -0
- package/docs/RunTemplateCreateRequest.md +37 -0
- package/docs/RunTemplateParameter.md +37 -0
- package/docs/RunTemplateParameterCreateRequest.md +37 -0
- package/docs/RunTemplateParameterGroup.md +33 -0
- package/docs/RunTemplateParameterGroupCreateRequest.md +33 -0
- package/docs/RunTemplateParameterGroupUpdateRequest.md +31 -0
- package/docs/RunTemplateParameterUpdateRequest.md +35 -0
- package/docs/RunTemplateParameterValue.md +25 -0
- package/docs/RunTemplateResourceSizing.md +23 -0
- package/docs/RunTemplateUpdateRequest.md +35 -0
- package/docs/Runner.md +61 -0
- package/docs/RunnerAccessControl.md +23 -0
- package/docs/RunnerApi.md +908 -0
- package/docs/RunnerCreateRequest.md +45 -0
- package/docs/RunnerEditInfo.md +22 -0
- package/docs/RunnerResourceSizing.md +23 -0
- package/docs/RunnerRole.md +21 -0
- package/docs/RunnerRunTemplateParameterValue.md +27 -0
- package/docs/RunnerSecurity.md +23 -0
- package/docs/RunnerUpdateRequest.md +39 -0
- package/docs/RunnerValidationStatus.md +15 -0
- package/docs/SendRunDataRequest.md +23 -0
- package/docs/Solution.md +53 -0
- package/docs/SolutionAccessControl.md +23 -0
- package/docs/SolutionApi.md +1870 -0
- package/docs/SolutionCreateRequest.md +43 -0
- package/docs/SolutionEditInfo.md +22 -0
- package/docs/SolutionFile.md +21 -0
- package/docs/SolutionRole.md +21 -0
- package/docs/SolutionSecurity.md +23 -0
- package/docs/SolutionUpdateRequest.md +41 -0
- package/docs/Workspace.md +45 -0
- package/docs/WorkspaceAccessControl.md +23 -0
- package/docs/WorkspaceApi.md +1044 -0
- package/docs/WorkspaceCreateRequest.md +37 -0
- package/docs/WorkspaceEditInfo.md +22 -0
- package/docs/WorkspaceFile.md +21 -0
- package/docs/WorkspaceRole.md +21 -0
- package/docs/WorkspaceSecurity.md +23 -0
- package/docs/WorkspaceSolution.md +25 -0
- package/docs/WorkspaceUpdateRequest.md +33 -0
- package/docs/WorkspaceWebApp.md +25 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/scripts/git_push.sh +1 -1
package/docs/RunData.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# RunData
|
|
2
|
+
|
|
3
|
+
Run Data stored
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**database_name** | **string** | Database name | [optional] [default to undefined]
|
|
10
|
+
**table_name** | **string** | Table name | [optional] [default to undefined]
|
|
11
|
+
**data** | **Array<{ [key: string]: any; }>** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { RunData } from '@cosmotech/api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: RunData = {
|
|
19
|
+
database_name,
|
|
20
|
+
table_name,
|
|
21
|
+
data,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# RunDataQuery
|
|
2
|
+
|
|
3
|
+
a data result query in SQL
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**query** | **string** | the query in SQL | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { RunDataQuery } from '@cosmotech/api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: RunDataQuery = {
|
|
17
|
+
query,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RunEditInfo
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**timestamp** | **number** | The timestamp of the modification in millisecond | [default to undefined]
|
|
9
|
+
**userId** | **string** | The id of the user who did the modification | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { RunEditInfo } from '@cosmotech/api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: RunEditInfo = {
|
|
17
|
+
timestamp,
|
|
18
|
+
userId,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# RunResourceRequested
|
|
2
|
+
|
|
3
|
+
the memory and CPU requested by the pod
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**cpu** | **number** | the cpu requested | [optional] [default to undefined]
|
|
10
|
+
**memory** | **number** | the memory requested | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { RunResourceRequested } from '@cosmotech/api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: RunResourceRequested = {
|
|
18
|
+
cpu,
|
|
19
|
+
memory,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/RunState.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# RunState
|
|
2
|
+
|
|
3
|
+
the Run end-to-end state
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Running` (value: `'Running'`)
|
|
8
|
+
|
|
9
|
+
* `Successful` (value: `'Successful'`)
|
|
10
|
+
|
|
11
|
+
* `Failed` (value: `'Failed'`)
|
|
12
|
+
|
|
13
|
+
* `Unknown` (value: `'Unknown'`)
|
|
14
|
+
|
|
15
|
+
* `NotStarted` (value: `'NotStarted'`)
|
|
16
|
+
|
|
17
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# RunStatus
|
|
2
|
+
|
|
3
|
+
a Run status
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | the Run id | [optional] [default to undefined]
|
|
10
|
+
**organizationId** | **string** | the Organization id | [optional] [default to undefined]
|
|
11
|
+
**workspaceId** | **string** | the Workspace id | [optional] [default to undefined]
|
|
12
|
+
**runnerId** | **string** | the Runner id | [optional] [default to undefined]
|
|
13
|
+
**workflowId** | **string** | the Cosmo Tech compute cluster Argo Workflow Id to search | [optional] [default to undefined]
|
|
14
|
+
**workflowName** | **string** | the Cosmo Tech compute cluster Argo Workflow Name | [optional] [default to undefined]
|
|
15
|
+
**createInfo** | [**RunEditInfo**](RunEditInfo.md) | The timestamp of the Run creation in milliseconds | [optional] [default to undefined]
|
|
16
|
+
**startTime** | **string** | the Run start Date Time | [optional] [default to undefined]
|
|
17
|
+
**endTime** | **string** | the Run end Date Time | [optional] [default to undefined]
|
|
18
|
+
**phase** | **string** | high-level summary of where the workflow is in its lifecycle | [optional] [default to undefined]
|
|
19
|
+
**progress** | **string** | progress to completion | [optional] [default to undefined]
|
|
20
|
+
**message** | **string** | a human readable message indicating details about why the workflow is in this condition | [optional] [default to undefined]
|
|
21
|
+
**estimatedDuration** | **number** | estimatedDuration in seconds | [optional] [default to undefined]
|
|
22
|
+
**nodes** | [**Array<RunStatusNode>**](RunStatusNode.md) | status of Run nodes | [optional] [default to undefined]
|
|
23
|
+
**state** | [**RunState**](RunState.md) | | [optional] [default to undefined]
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { RunStatus } from '@cosmotech/api-ts';
|
|
29
|
+
|
|
30
|
+
const instance: RunStatus = {
|
|
31
|
+
id,
|
|
32
|
+
organizationId,
|
|
33
|
+
workspaceId,
|
|
34
|
+
runnerId,
|
|
35
|
+
workflowId,
|
|
36
|
+
workflowName,
|
|
37
|
+
createInfo,
|
|
38
|
+
startTime,
|
|
39
|
+
endTime,
|
|
40
|
+
phase,
|
|
41
|
+
progress,
|
|
42
|
+
message,
|
|
43
|
+
estimatedDuration,
|
|
44
|
+
nodes,
|
|
45
|
+
state,
|
|
46
|
+
};
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# RunStatusNode
|
|
2
|
+
|
|
3
|
+
status of a Run Node
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | the node id | [optional] [default to undefined]
|
|
10
|
+
**name** | **string** | the node unique name | [optional] [default to undefined]
|
|
11
|
+
**containerName** | **string** | the Run container name | [optional] [default to undefined]
|
|
12
|
+
**outboundNodes** | **Array<string>** | the list of outbound nodes | [optional] [readonly] [default to undefined]
|
|
13
|
+
**resourcesDuration** | [**RunResourceRequested**](RunResourceRequested.md) | | [optional] [default to undefined]
|
|
14
|
+
**estimatedDuration** | **number** | estimatedDuration in seconds | [optional] [default to undefined]
|
|
15
|
+
**hostNodeName** | **string** | HostNodeName name of the Kubernetes node on which the Pod is running, if applicable | [optional] [default to undefined]
|
|
16
|
+
**message** | **string** | a human readable message indicating details about why the node is in this condition | [optional] [default to undefined]
|
|
17
|
+
**phase** | **string** | high-level summary of where the node is in its lifecycle | [optional] [default to undefined]
|
|
18
|
+
**progress** | **string** | progress to completion | [optional] [default to undefined]
|
|
19
|
+
**startTime** | **string** | the node start time | [optional] [default to undefined]
|
|
20
|
+
**endTime** | **string** | the node end time | [optional] [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { RunStatusNode } from '@cosmotech/api-ts';
|
|
26
|
+
|
|
27
|
+
const instance: RunStatusNode = {
|
|
28
|
+
id,
|
|
29
|
+
name,
|
|
30
|
+
containerName,
|
|
31
|
+
outboundNodes,
|
|
32
|
+
resourcesDuration,
|
|
33
|
+
estimatedDuration,
|
|
34
|
+
hostNodeName,
|
|
35
|
+
message,
|
|
36
|
+
phase,
|
|
37
|
+
progress,
|
|
38
|
+
startTime,
|
|
39
|
+
endTime,
|
|
40
|
+
};
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# RunTemplate
|
|
2
|
+
|
|
3
|
+
A Solution Run Template
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The Solution Run Template id | [default to undefined]
|
|
10
|
+
**name** | **string** | The Run Template name | [optional] [default to undefined]
|
|
11
|
+
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
12
|
+
**description** | **string** | The Run Template description | [optional] [default to undefined]
|
|
13
|
+
**tags** | **Array<string>** | The list of Run Template tags | [optional] [default to undefined]
|
|
14
|
+
**computeSize** | **string** | The compute size needed for this Run Template | [optional] [default to undefined]
|
|
15
|
+
**runSizing** | [**RunTemplateResourceSizing**](RunTemplateResourceSizing.md) | | [optional] [default to undefined]
|
|
16
|
+
**parameterGroups** | **Array<string>** | The ordered list of parameters groups for the Run Template | [default to undefined]
|
|
17
|
+
**executionTimeout** | **number** | An optional duration in seconds in which a workflow is allowed to run | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { RunTemplate } from '@cosmotech/api-ts';
|
|
23
|
+
|
|
24
|
+
const instance: RunTemplate = {
|
|
25
|
+
id,
|
|
26
|
+
name,
|
|
27
|
+
labels,
|
|
28
|
+
description,
|
|
29
|
+
tags,
|
|
30
|
+
computeSize,
|
|
31
|
+
runSizing,
|
|
32
|
+
parameterGroups,
|
|
33
|
+
executionTimeout,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# RunTemplateCreateRequest
|
|
2
|
+
|
|
3
|
+
A Solution Run Template Create Request
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The Solution Run Template id | [default to undefined]
|
|
10
|
+
**name** | **string** | The Run Template name | [optional] [default to undefined]
|
|
11
|
+
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
12
|
+
**description** | **string** | The Run Template description | [optional] [default to undefined]
|
|
13
|
+
**tags** | **Array<string>** | The list of Run Template tags | [optional] [default to undefined]
|
|
14
|
+
**computeSize** | **string** | The compute size needed for this Run Template | [optional] [default to undefined]
|
|
15
|
+
**runSizing** | [**RunTemplateResourceSizing**](RunTemplateResourceSizing.md) | | [optional] [default to undefined]
|
|
16
|
+
**parameterGroups** | **Array<string>** | The ordered list of parameters groups for the Run Template | [optional] [default to undefined]
|
|
17
|
+
**executionTimeout** | **number** | An optional duration in seconds in which a workflow is allowed to run | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { RunTemplateCreateRequest } from '@cosmotech/api-ts';
|
|
23
|
+
|
|
24
|
+
const instance: RunTemplateCreateRequest = {
|
|
25
|
+
id,
|
|
26
|
+
name,
|
|
27
|
+
labels,
|
|
28
|
+
description,
|
|
29
|
+
tags,
|
|
30
|
+
computeSize,
|
|
31
|
+
runSizing,
|
|
32
|
+
parameterGroups,
|
|
33
|
+
executionTimeout,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# RunTemplateParameter
|
|
2
|
+
|
|
3
|
+
A Run Template Parameter
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The Parameter id | [default to undefined]
|
|
10
|
+
**description** | **string** | The parameter description | [optional] [default to undefined]
|
|
11
|
+
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
12
|
+
**varType** | **string** | The variable type for the parameter. Basic types or special type %DATASETID% | [default to undefined]
|
|
13
|
+
**defaultValue** | **string** | The default value for this parameter | [optional] [default to undefined]
|
|
14
|
+
**minValue** | **string** | The minimum value for this parameter | [optional] [default to undefined]
|
|
15
|
+
**maxValue** | **string** | The maximum value for this parameter | [optional] [default to undefined]
|
|
16
|
+
**regexValidation** | **string** | A regex to validate the value | [optional] [default to undefined]
|
|
17
|
+
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { RunTemplateParameter } from '@cosmotech/api-ts';
|
|
23
|
+
|
|
24
|
+
const instance: RunTemplateParameter = {
|
|
25
|
+
id,
|
|
26
|
+
description,
|
|
27
|
+
labels,
|
|
28
|
+
varType,
|
|
29
|
+
defaultValue,
|
|
30
|
+
minValue,
|
|
31
|
+
maxValue,
|
|
32
|
+
regexValidation,
|
|
33
|
+
_options,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# RunTemplateParameterCreateRequest
|
|
2
|
+
|
|
3
|
+
A Run Template Parameter for creation
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The Parameter id | [default to undefined]
|
|
10
|
+
**description** | **string** | The parameter description | [optional] [default to undefined]
|
|
11
|
+
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
12
|
+
**varType** | **string** | The variable type for the parameter. Basic types or special type %DATASETID% | [default to undefined]
|
|
13
|
+
**defaultValue** | **string** | The default value for this parameter | [optional] [default to undefined]
|
|
14
|
+
**minValue** | **string** | The minimum value for this parameter | [optional] [default to undefined]
|
|
15
|
+
**maxValue** | **string** | The maximum value for this parameter | [optional] [default to undefined]
|
|
16
|
+
**regexValidation** | **string** | A regex to validate the value | [optional] [default to undefined]
|
|
17
|
+
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { RunTemplateParameterCreateRequest } from '@cosmotech/api-ts';
|
|
23
|
+
|
|
24
|
+
const instance: RunTemplateParameterCreateRequest = {
|
|
25
|
+
id,
|
|
26
|
+
description,
|
|
27
|
+
labels,
|
|
28
|
+
varType,
|
|
29
|
+
defaultValue,
|
|
30
|
+
minValue,
|
|
31
|
+
maxValue,
|
|
32
|
+
regexValidation,
|
|
33
|
+
_options,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# RunTemplateParameterGroup
|
|
2
|
+
|
|
3
|
+
A Parameter Group for a Run Template
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The Parameter Group id | [default to undefined]
|
|
10
|
+
**description** | **string** | A description of the parameter group | [optional] [default to undefined]
|
|
11
|
+
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
12
|
+
**isTable** | **boolean** | Does the group define a table | [default to undefined]
|
|
13
|
+
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
14
|
+
**parentId** | **string** | The Run Template Group parent Id | [optional] [default to undefined]
|
|
15
|
+
**parameters** | **Array<string>** | An ordered list of Run Template Parameters | [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { RunTemplateParameterGroup } from '@cosmotech/api-ts';
|
|
21
|
+
|
|
22
|
+
const instance: RunTemplateParameterGroup = {
|
|
23
|
+
id,
|
|
24
|
+
description,
|
|
25
|
+
labels,
|
|
26
|
+
isTable,
|
|
27
|
+
_options,
|
|
28
|
+
parentId,
|
|
29
|
+
parameters,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# RunTemplateParameterGroupCreateRequest
|
|
2
|
+
|
|
3
|
+
A Parameter Group Create Request for a Run Template
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The Parameter Group id | [default to undefined]
|
|
10
|
+
**description** | **string** | A description of the parameter group | [optional] [default to undefined]
|
|
11
|
+
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
12
|
+
**isTable** | **boolean** | Does the group define a table | [optional] [default to false]
|
|
13
|
+
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
14
|
+
**parentId** | **string** | The Run Template Group parent Id | [optional] [default to undefined]
|
|
15
|
+
**parameters** | **Array<string>** | An ordered list of Run Template Parameters | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { RunTemplateParameterGroupCreateRequest } from '@cosmotech/api-ts';
|
|
21
|
+
|
|
22
|
+
const instance: RunTemplateParameterGroupCreateRequest = {
|
|
23
|
+
id,
|
|
24
|
+
description,
|
|
25
|
+
labels,
|
|
26
|
+
isTable,
|
|
27
|
+
_options,
|
|
28
|
+
parentId,
|
|
29
|
+
parameters,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# RunTemplateParameterGroupUpdateRequest
|
|
2
|
+
|
|
3
|
+
A Parameter Group Update Request for a Run Template
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**description** | **string** | A description of the parameter group | [optional] [default to undefined]
|
|
10
|
+
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
11
|
+
**isTable** | **boolean** | Does the group define a table | [optional] [default to undefined]
|
|
12
|
+
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
13
|
+
**parentId** | **string** | The Run Template Group parent Id | [optional] [default to undefined]
|
|
14
|
+
**parameters** | **Array<string>** | An ordered list of Run Template Parameters | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { RunTemplateParameterGroupUpdateRequest } from '@cosmotech/api-ts';
|
|
20
|
+
|
|
21
|
+
const instance: RunTemplateParameterGroupUpdateRequest = {
|
|
22
|
+
description,
|
|
23
|
+
labels,
|
|
24
|
+
isTable,
|
|
25
|
+
_options,
|
|
26
|
+
parentId,
|
|
27
|
+
parameters,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# RunTemplateParameterUpdateRequest
|
|
2
|
+
|
|
3
|
+
A Run Template Parameter for update parameter
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**description** | **string** | The parameter description | [optional] [default to undefined]
|
|
10
|
+
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
11
|
+
**varType** | **string** | The variable type for the parameter. Basic types or special type %DATASETID% | [optional] [default to undefined]
|
|
12
|
+
**defaultValue** | **string** | The default value for this parameter | [optional] [default to undefined]
|
|
13
|
+
**minValue** | **string** | The minimum value for this parameter | [optional] [default to undefined]
|
|
14
|
+
**maxValue** | **string** | The maximum value for this parameter | [optional] [default to undefined]
|
|
15
|
+
**regexValidation** | **string** | A regex to validate the value | [optional] [default to undefined]
|
|
16
|
+
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { RunTemplateParameterUpdateRequest } from '@cosmotech/api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: RunTemplateParameterUpdateRequest = {
|
|
24
|
+
description,
|
|
25
|
+
labels,
|
|
26
|
+
varType,
|
|
27
|
+
defaultValue,
|
|
28
|
+
minValue,
|
|
29
|
+
maxValue,
|
|
30
|
+
regexValidation,
|
|
31
|
+
_options,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# RunTemplateParameterValue
|
|
2
|
+
|
|
3
|
+
the value of Analysis parameter for a Runner for this Run
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**parameterId** | **string** | the parameter Id | [default to undefined]
|
|
10
|
+
**varType** | **string** | the parameter value type | [optional] [readonly] [default to undefined]
|
|
11
|
+
**value** | **string** | the parameter value | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { RunTemplateParameterValue } from '@cosmotech/api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: RunTemplateParameterValue = {
|
|
19
|
+
parameterId,
|
|
20
|
+
varType,
|
|
21
|
+
value,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# RunTemplateResourceSizing
|
|
2
|
+
|
|
3
|
+
A description object for resource requests and limits
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**requests** | [**ResourceSizeInfo**](ResourceSizeInfo.md) | | [default to undefined]
|
|
10
|
+
**limits** | [**ResourceSizeInfo**](ResourceSizeInfo.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { RunTemplateResourceSizing } from '@cosmotech/api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: RunTemplateResourceSizing = {
|
|
18
|
+
requests,
|
|
19
|
+
limits,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# RunTemplateUpdateRequest
|
|
2
|
+
|
|
3
|
+
A Solution Run Template Create Request
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**name** | **string** | The Run Template name | [optional] [default to undefined]
|
|
10
|
+
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
11
|
+
**description** | **string** | The Run Template description | [optional] [default to undefined]
|
|
12
|
+
**tags** | **Array<string>** | The list of Run Template tags | [optional] [default to undefined]
|
|
13
|
+
**computeSize** | **string** | The compute size needed for this Run Template | [optional] [default to undefined]
|
|
14
|
+
**runSizing** | [**RunTemplateResourceSizing**](RunTemplateResourceSizing.md) | | [optional] [default to undefined]
|
|
15
|
+
**parameterGroups** | **Array<string>** | The ordered list of parameters groups for the Run Template | [optional] [default to undefined]
|
|
16
|
+
**executionTimeout** | **number** | An optional duration in seconds in which a workflow is allowed to run | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { RunTemplateUpdateRequest } from '@cosmotech/api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: RunTemplateUpdateRequest = {
|
|
24
|
+
name,
|
|
25
|
+
labels,
|
|
26
|
+
description,
|
|
27
|
+
tags,
|
|
28
|
+
computeSize,
|
|
29
|
+
runSizing,
|
|
30
|
+
parameterGroups,
|
|
31
|
+
executionTimeout,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Runner.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Runner
|
|
2
|
+
|
|
3
|
+
a Runner with complete information
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | the Runner unique identifier | [readonly] [default to undefined]
|
|
10
|
+
**name** | **string** | the Runner name | [default to undefined]
|
|
11
|
+
**description** | **string** | the Runner description | [optional] [default to undefined]
|
|
12
|
+
**tags** | **Array<string>** | the list of tags | [optional] [default to undefined]
|
|
13
|
+
**parentId** | **string** | the Runner parent id | [optional] [default to undefined]
|
|
14
|
+
**createInfo** | [**RunnerEditInfo**](RunnerEditInfo.md) | The details of the Runner creation | [default to undefined]
|
|
15
|
+
**updateInfo** | [**RunnerEditInfo**](RunnerEditInfo.md) | The details of the Runner last update | [default to undefined]
|
|
16
|
+
**rootId** | **string** | the runner root id | [optional] [readonly] [default to undefined]
|
|
17
|
+
**solutionId** | **string** | the Solution Id associated with this Runner | [readonly] [default to undefined]
|
|
18
|
+
**runTemplateId** | **string** | the Solution Run Template Id associated with this Runner | [default to undefined]
|
|
19
|
+
**organizationId** | **string** | the associated Organization Id | [readonly] [default to undefined]
|
|
20
|
+
**workspaceId** | **string** | the associated Workspace Id | [readonly] [default to undefined]
|
|
21
|
+
**ownerName** | **string** | the name of the owner | [readonly] [default to undefined]
|
|
22
|
+
**solutionName** | **string** | the Solution name | [optional] [readonly] [default to undefined]
|
|
23
|
+
**runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [readonly] [default to undefined]
|
|
24
|
+
**datasetList** | **Array<string>** | the list of Dataset Id associated to this Runner Run Template | [default to undefined]
|
|
25
|
+
**runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) | | [optional] [default to undefined]
|
|
26
|
+
**parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [default to undefined]
|
|
27
|
+
**lastRunInfo** | [**LastRunInfo**](LastRunInfo.md) | | [default to undefined]
|
|
28
|
+
**validationStatus** | [**RunnerValidationStatus**](RunnerValidationStatus.md) | | [default to undefined]
|
|
29
|
+
**security** | [**RunnerSecurity**](RunnerSecurity.md) | | [default to undefined]
|
|
30
|
+
|
|
31
|
+
## Example
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import { Runner } from '@cosmotech/api-ts';
|
|
35
|
+
|
|
36
|
+
const instance: Runner = {
|
|
37
|
+
id,
|
|
38
|
+
name,
|
|
39
|
+
description,
|
|
40
|
+
tags,
|
|
41
|
+
parentId,
|
|
42
|
+
createInfo,
|
|
43
|
+
updateInfo,
|
|
44
|
+
rootId,
|
|
45
|
+
solutionId,
|
|
46
|
+
runTemplateId,
|
|
47
|
+
organizationId,
|
|
48
|
+
workspaceId,
|
|
49
|
+
ownerName,
|
|
50
|
+
solutionName,
|
|
51
|
+
runTemplateName,
|
|
52
|
+
datasetList,
|
|
53
|
+
runSizing,
|
|
54
|
+
parametersValues,
|
|
55
|
+
lastRunInfo,
|
|
56
|
+
validationStatus,
|
|
57
|
+
security,
|
|
58
|
+
};
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# RunnerAccessControl
|
|
2
|
+
|
|
3
|
+
a Runner access control item
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | the identity id | [default to undefined]
|
|
10
|
+
**role** | **string** | a role | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { RunnerAccessControl } from '@cosmotech/api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: RunnerAccessControl = {
|
|
18
|
+
id,
|
|
19
|
+
role,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|