@cosmotech/api-ts 5.0.0-beta6 → 5.0.0-rc2
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 +1 -3
- package/README.md +3 -5
- package/api.ts +198 -290
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +222 -296
- package/dist/api.js +105 -105
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Dataset.md +4 -2
- package/docs/DatasetApi.md +19 -15
- package/docs/DatasetCreateInfo.md +24 -0
- package/docs/DatasetCreateRequest.md +2 -2
- package/docs/DatasetEditInfo.md +22 -0
- package/docs/DatasetPart.md +4 -2
- package/docs/DatasetPartCreateRequest.md +2 -0
- package/docs/DatasetPartUpdateRequest.md +2 -0
- package/docs/DatasetUpdateRequest.md +2 -2
- package/docs/RunApi.md +38 -38
- package/docs/RunTemplateParameter.md +2 -4
- package/docs/RunTemplateParameterCreateRequest.md +2 -4
- package/docs/RunTemplateParameterGroup.md +2 -6
- package/docs/RunTemplateParameterGroupCreateRequest.md +2 -6
- package/docs/RunTemplateParameterGroupUpdateRequest.md +2 -6
- package/docs/RunTemplateParameterUpdateRequest.md +2 -4
- package/docs/Runner.md +3 -3
- package/docs/RunnerCreateRequest.md +2 -2
- package/docs/RunnerUpdateRequest.md +2 -2
- package/docs/Workspace.md +2 -2
- package/docs/WorkspaceApi.md +2 -2
- package/docs/WorkspaceCreateRequest.md +2 -2
- package/docs/WorkspaceSolution.md +0 -4
- package/docs/WorkspaceUpdateRequest.md +2 -2
- package/index.ts +1 -1
- package/package.json +1 -1
|
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**name** | **string** | | [default to undefined]
|
|
10
10
|
**description** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**tags** | **Array<string>** | | [optional] [default to undefined]
|
|
12
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
12
13
|
**parts** | [**Array<DatasetPartCreateRequest>**](DatasetPartCreateRequest.md) | | [optional] [default to undefined]
|
|
13
14
|
**security** | [**DatasetSecurity**](DatasetSecurity.md) | | [optional] [default to undefined]
|
|
14
|
-
**runnerId** | **string** | | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -22,9 +22,9 @@ const instance: DatasetCreateRequest = {
|
|
|
22
22
|
name,
|
|
23
23
|
description,
|
|
24
24
|
tags,
|
|
25
|
+
additionalData,
|
|
25
26
|
parts,
|
|
26
27
|
security,
|
|
27
|
-
runnerId,
|
|
28
28
|
};
|
|
29
29
|
```
|
|
30
30
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# DatasetEditInfo
|
|
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 { DatasetEditInfo } from '@cosmotech/api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: DatasetEditInfo = {
|
|
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)
|
package/docs/DatasetPart.md
CHANGED
|
@@ -11,12 +11,13 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**sourceName** | **string** | the source data name (e.g. filename associated to the dataset part) | [default to undefined]
|
|
12
12
|
**description** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**tags** | **Array<string>** | | [default to undefined]
|
|
14
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
14
15
|
**type** | [**DatasetPartTypeEnum**](DatasetPartTypeEnum.md) | | [default to undefined]
|
|
15
16
|
**organizationId** | **string** | the associated Organization Id | [readonly] [default to undefined]
|
|
16
17
|
**workspaceId** | **string** | the associated Workspace Id | [readonly] [default to undefined]
|
|
17
18
|
**datasetId** | **string** | the associated Dataset Id | [readonly] [default to undefined]
|
|
18
|
-
**createInfo** | [**
|
|
19
|
-
**updateInfo** | [**
|
|
19
|
+
**createInfo** | [**DatasetEditInfo**](DatasetEditInfo.md) | The details of the Dataset creation | [default to undefined]
|
|
20
|
+
**updateInfo** | [**DatasetEditInfo**](DatasetEditInfo.md) | The details of the Dataset last update | [default to undefined]
|
|
20
21
|
|
|
21
22
|
## Example
|
|
22
23
|
|
|
@@ -29,6 +30,7 @@ const instance: DatasetPart = {
|
|
|
29
30
|
sourceName,
|
|
30
31
|
description,
|
|
31
32
|
tags,
|
|
33
|
+
additionalData,
|
|
32
34
|
type,
|
|
33
35
|
organizationId,
|
|
34
36
|
workspaceId,
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**sourceName** | **string** | the source data name (e.g. filename associated to the dataset part) | [default to undefined]
|
|
11
11
|
**description** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**tags** | **Array<string>** | | [optional] [default to undefined]
|
|
13
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
13
14
|
**type** | [**DatasetPartTypeEnum**](DatasetPartTypeEnum.md) | | [optional] [default to undefined]
|
|
14
15
|
|
|
15
16
|
## Example
|
|
@@ -22,6 +23,7 @@ const instance: DatasetPartCreateRequest = {
|
|
|
22
23
|
sourceName,
|
|
23
24
|
description,
|
|
24
25
|
tags,
|
|
26
|
+
additionalData,
|
|
25
27
|
type,
|
|
26
28
|
};
|
|
27
29
|
```
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**sourceName** | **string** | the source data name (e.g. filename associated to the dataset part) | [optional] [default to undefined]
|
|
10
10
|
**description** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**tags** | **Array<string>** | | [optional] [default to undefined]
|
|
12
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -19,6 +20,7 @@ const instance: DatasetPartUpdateRequest = {
|
|
|
19
20
|
sourceName,
|
|
20
21
|
description,
|
|
21
22
|
tags,
|
|
23
|
+
additionalData,
|
|
22
24
|
};
|
|
23
25
|
```
|
|
24
26
|
|
|
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**name** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**description** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**tags** | **Array<string>** | | [optional] [default to undefined]
|
|
12
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
12
13
|
**parts** | [**Array<DatasetPartCreateRequest>**](DatasetPartCreateRequest.md) | | [optional] [default to undefined]
|
|
13
|
-
**security** | [**DatasetSecurity**](DatasetSecurity.md) | | [optional] [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -21,8 +21,8 @@ const instance: DatasetUpdateRequest = {
|
|
|
21
21
|
name,
|
|
22
22
|
description,
|
|
23
23
|
tags,
|
|
24
|
+
additionalData,
|
|
24
25
|
parts,
|
|
25
|
-
security,
|
|
26
26
|
};
|
|
27
27
|
```
|
|
28
28
|
|
package/docs/RunApi.md
CHANGED
|
@@ -25,10 +25,10 @@ import {
|
|
|
25
25
|
const configuration = new Configuration();
|
|
26
26
|
const apiInstance = new RunApi(configuration);
|
|
27
27
|
|
|
28
|
-
let organizationId: string; //
|
|
29
|
-
let workspaceId: string; //
|
|
30
|
-
let runnerId: string; //
|
|
31
|
-
let runId: string; //
|
|
28
|
+
let organizationId: string; //The Organization identifier (default to undefined)
|
|
29
|
+
let workspaceId: string; //The Workspace identifier (default to undefined)
|
|
30
|
+
let runnerId: string; //The Runner identifier (default to undefined)
|
|
31
|
+
let runId: string; //The Run identifier (default to undefined)
|
|
32
32
|
|
|
33
33
|
const { status, data } = await apiInstance.deleteRun(
|
|
34
34
|
organizationId,
|
|
@@ -42,10 +42,10 @@ const { status, data } = await apiInstance.deleteRun(
|
|
|
42
42
|
|
|
43
43
|
|Name | Type | Description | Notes|
|
|
44
44
|
|------------- | ------------- | ------------- | -------------|
|
|
45
|
-
| **organizationId** | [**string**] |
|
|
46
|
-
| **workspaceId** | [**string**] |
|
|
47
|
-
| **runnerId** | [**string**] |
|
|
48
|
-
| **runId** | [**string**] |
|
|
45
|
+
| **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
|
|
46
|
+
| **workspaceId** | [**string**] | The Workspace identifier | defaults to undefined|
|
|
47
|
+
| **runnerId** | [**string**] | The Runner identifier | defaults to undefined|
|
|
48
|
+
| **runId** | [**string**] | The Run identifier | defaults to undefined|
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
### Return type
|
|
@@ -86,10 +86,10 @@ import {
|
|
|
86
86
|
const configuration = new Configuration();
|
|
87
87
|
const apiInstance = new RunApi(configuration);
|
|
88
88
|
|
|
89
|
-
let organizationId: string; //
|
|
90
|
-
let workspaceId: string; //
|
|
91
|
-
let runnerId: string; //
|
|
92
|
-
let runId: string; //
|
|
89
|
+
let organizationId: string; //The Organization identifier (default to undefined)
|
|
90
|
+
let workspaceId: string; //The Workspace identifier (default to undefined)
|
|
91
|
+
let runnerId: string; //The Runner identifier (default to undefined)
|
|
92
|
+
let runId: string; //The Run identifier (default to undefined)
|
|
93
93
|
|
|
94
94
|
const { status, data } = await apiInstance.getRun(
|
|
95
95
|
organizationId,
|
|
@@ -103,10 +103,10 @@ const { status, data } = await apiInstance.getRun(
|
|
|
103
103
|
|
|
104
104
|
|Name | Type | Description | Notes|
|
|
105
105
|
|------------- | ------------- | ------------- | -------------|
|
|
106
|
-
| **organizationId** | [**string**] |
|
|
107
|
-
| **workspaceId** | [**string**] |
|
|
108
|
-
| **runnerId** | [**string**] |
|
|
109
|
-
| **runId** | [**string**] |
|
|
106
|
+
| **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
|
|
107
|
+
| **workspaceId** | [**string**] | The Workspace identifier | defaults to undefined|
|
|
108
|
+
| **runnerId** | [**string**] | The Runner identifier | defaults to undefined|
|
|
109
|
+
| **runId** | [**string**] | The Run identifier | defaults to undefined|
|
|
110
110
|
|
|
111
111
|
|
|
112
112
|
### Return type
|
|
@@ -146,10 +146,10 @@ import {
|
|
|
146
146
|
const configuration = new Configuration();
|
|
147
147
|
const apiInstance = new RunApi(configuration);
|
|
148
148
|
|
|
149
|
-
let organizationId: string; //
|
|
150
|
-
let workspaceId: string; //
|
|
151
|
-
let runnerId: string; //
|
|
152
|
-
let runId: string; //
|
|
149
|
+
let organizationId: string; //The Organization identifier (default to undefined)
|
|
150
|
+
let workspaceId: string; //The Workspace identifier (default to undefined)
|
|
151
|
+
let runnerId: string; //The Runner identifier (default to undefined)
|
|
152
|
+
let runId: string; //The Run identifier (default to undefined)
|
|
153
153
|
|
|
154
154
|
const { status, data } = await apiInstance.getRunLogs(
|
|
155
155
|
organizationId,
|
|
@@ -163,10 +163,10 @@ const { status, data } = await apiInstance.getRunLogs(
|
|
|
163
163
|
|
|
164
164
|
|Name | Type | Description | Notes|
|
|
165
165
|
|------------- | ------------- | ------------- | -------------|
|
|
166
|
-
| **organizationId** | [**string**] |
|
|
167
|
-
| **workspaceId** | [**string**] |
|
|
168
|
-
| **runnerId** | [**string**] |
|
|
169
|
-
| **runId** | [**string**] |
|
|
166
|
+
| **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
|
|
167
|
+
| **workspaceId** | [**string**] | The Workspace identifier | defaults to undefined|
|
|
168
|
+
| **runnerId** | [**string**] | The Runner identifier | defaults to undefined|
|
|
169
|
+
| **runId** | [**string**] | The Run identifier | defaults to undefined|
|
|
170
170
|
|
|
171
171
|
|
|
172
172
|
### Return type
|
|
@@ -205,10 +205,10 @@ import {
|
|
|
205
205
|
const configuration = new Configuration();
|
|
206
206
|
const apiInstance = new RunApi(configuration);
|
|
207
207
|
|
|
208
|
-
let organizationId: string; //
|
|
209
|
-
let workspaceId: string; //
|
|
210
|
-
let runnerId: string; //
|
|
211
|
-
let runId: string; //
|
|
208
|
+
let organizationId: string; //The Organization identifier (default to undefined)
|
|
209
|
+
let workspaceId: string; //The Workspace identifier (default to undefined)
|
|
210
|
+
let runnerId: string; //The Runner identifier (default to undefined)
|
|
211
|
+
let runId: string; //The Run identifier (default to undefined)
|
|
212
212
|
|
|
213
213
|
const { status, data } = await apiInstance.getRunStatus(
|
|
214
214
|
organizationId,
|
|
@@ -222,10 +222,10 @@ const { status, data } = await apiInstance.getRunStatus(
|
|
|
222
222
|
|
|
223
223
|
|Name | Type | Description | Notes|
|
|
224
224
|
|------------- | ------------- | ------------- | -------------|
|
|
225
|
-
| **organizationId** | [**string**] |
|
|
226
|
-
| **workspaceId** | [**string**] |
|
|
227
|
-
| **runnerId** | [**string**] |
|
|
228
|
-
| **runId** | [**string**] |
|
|
225
|
+
| **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
|
|
226
|
+
| **workspaceId** | [**string**] | The Workspace identifier | defaults to undefined|
|
|
227
|
+
| **runnerId** | [**string**] | The Runner identifier | defaults to undefined|
|
|
228
|
+
| **runId** | [**string**] | The Run identifier | defaults to undefined|
|
|
229
229
|
|
|
230
230
|
|
|
231
231
|
### Return type
|
|
@@ -264,9 +264,9 @@ import {
|
|
|
264
264
|
const configuration = new Configuration();
|
|
265
265
|
const apiInstance = new RunApi(configuration);
|
|
266
266
|
|
|
267
|
-
let organizationId: string; //
|
|
268
|
-
let workspaceId: string; //
|
|
269
|
-
let runnerId: string; //
|
|
267
|
+
let organizationId: string; //The Organization identifier (default to undefined)
|
|
268
|
+
let workspaceId: string; //The Workspace identifier (default to undefined)
|
|
269
|
+
let runnerId: string; //The Runner identifier (default to undefined)
|
|
270
270
|
let page: number; //page number to query (first page is at index 0) (optional) (default to undefined)
|
|
271
271
|
let size: number; //amount of result by page (optional) (default to undefined)
|
|
272
272
|
|
|
@@ -283,9 +283,9 @@ const { status, data } = await apiInstance.listRuns(
|
|
|
283
283
|
|
|
284
284
|
|Name | Type | Description | Notes|
|
|
285
285
|
|------------- | ------------- | ------------- | -------------|
|
|
286
|
-
| **organizationId** | [**string**] |
|
|
287
|
-
| **workspaceId** | [**string**] |
|
|
288
|
-
| **runnerId** | [**string**] |
|
|
286
|
+
| **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
|
|
287
|
+
| **workspaceId** | [**string**] | The Workspace identifier | defaults to undefined|
|
|
288
|
+
| **runnerId** | [**string**] | The Runner identifier | defaults to undefined|
|
|
289
289
|
| **page** | [**number**] | page number to query (first page is at index 0) | (optional) defaults to undefined|
|
|
290
290
|
| **size** | [**number**] | amount of result by page | (optional) defaults to undefined|
|
|
291
291
|
|
|
@@ -13,8 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**defaultValue** | **string** | The default value for this parameter | [optional] [default to undefined]
|
|
14
14
|
**minValue** | **string** | The minimum value for this parameter | [optional] [default to undefined]
|
|
15
15
|
**maxValue** | **string** | The maximum value for this parameter | [optional] [default to undefined]
|
|
16
|
-
**
|
|
17
|
-
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
16
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
18
17
|
|
|
19
18
|
## Example
|
|
20
19
|
|
|
@@ -29,8 +28,7 @@ const instance: RunTemplateParameter = {
|
|
|
29
28
|
defaultValue,
|
|
30
29
|
minValue,
|
|
31
30
|
maxValue,
|
|
32
|
-
|
|
33
|
-
_options,
|
|
31
|
+
additionalData,
|
|
34
32
|
};
|
|
35
33
|
```
|
|
36
34
|
|
|
@@ -13,8 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**defaultValue** | **string** | The default value for this parameter | [optional] [default to undefined]
|
|
14
14
|
**minValue** | **string** | The minimum value for this parameter | [optional] [default to undefined]
|
|
15
15
|
**maxValue** | **string** | The maximum value for this parameter | [optional] [default to undefined]
|
|
16
|
-
**
|
|
17
|
-
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
16
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
18
17
|
|
|
19
18
|
## Example
|
|
20
19
|
|
|
@@ -29,8 +28,7 @@ const instance: RunTemplateParameterCreateRequest = {
|
|
|
29
28
|
defaultValue,
|
|
30
29
|
minValue,
|
|
31
30
|
maxValue,
|
|
32
|
-
|
|
33
|
-
_options,
|
|
31
|
+
additionalData,
|
|
34
32
|
};
|
|
35
33
|
```
|
|
36
34
|
|
|
@@ -9,9 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**id** | **string** | The Parameter Group id | [default to undefined]
|
|
10
10
|
**description** | **string** | A description of the parameter group | [optional] [default to undefined]
|
|
11
11
|
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
12
|
-
**
|
|
13
|
-
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
14
|
-
**parentId** | **string** | The Run Template Group parent Id | [optional] [default to undefined]
|
|
12
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
15
13
|
**parameters** | **Array<string>** | An ordered list of Run Template Parameters | [default to undefined]
|
|
16
14
|
|
|
17
15
|
## Example
|
|
@@ -23,9 +21,7 @@ const instance: RunTemplateParameterGroup = {
|
|
|
23
21
|
id,
|
|
24
22
|
description,
|
|
25
23
|
labels,
|
|
26
|
-
|
|
27
|
-
_options,
|
|
28
|
-
parentId,
|
|
24
|
+
additionalData,
|
|
29
25
|
parameters,
|
|
30
26
|
};
|
|
31
27
|
```
|
|
@@ -9,9 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**id** | **string** | The Parameter Group id | [default to undefined]
|
|
10
10
|
**description** | **string** | A description of the parameter group | [optional] [default to undefined]
|
|
11
11
|
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
12
|
-
**
|
|
13
|
-
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
14
|
-
**parentId** | **string** | The Run Template Group parent Id | [optional] [default to undefined]
|
|
12
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
15
13
|
**parameters** | **Array<string>** | An ordered list of Run Template Parameters | [optional] [default to undefined]
|
|
16
14
|
|
|
17
15
|
## Example
|
|
@@ -23,9 +21,7 @@ const instance: RunTemplateParameterGroupCreateRequest = {
|
|
|
23
21
|
id,
|
|
24
22
|
description,
|
|
25
23
|
labels,
|
|
26
|
-
|
|
27
|
-
_options,
|
|
28
|
-
parentId,
|
|
24
|
+
additionalData,
|
|
29
25
|
parameters,
|
|
30
26
|
};
|
|
31
27
|
```
|
|
@@ -8,9 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**description** | **string** | A description of the parameter group | [optional] [default to undefined]
|
|
10
10
|
**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
|
|
11
|
-
**
|
|
12
|
-
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
13
|
-
**parentId** | **string** | The Run Template Group parent Id | [optional] [default to undefined]
|
|
11
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
14
12
|
**parameters** | **Array<string>** | An ordered list of Run Template Parameters | [optional] [default to undefined]
|
|
15
13
|
|
|
16
14
|
## Example
|
|
@@ -21,9 +19,7 @@ import { RunTemplateParameterGroupUpdateRequest } from '@cosmotech/api-ts';
|
|
|
21
19
|
const instance: RunTemplateParameterGroupUpdateRequest = {
|
|
22
20
|
description,
|
|
23
21
|
labels,
|
|
24
|
-
|
|
25
|
-
_options,
|
|
26
|
-
parentId,
|
|
22
|
+
additionalData,
|
|
27
23
|
parameters,
|
|
28
24
|
};
|
|
29
25
|
```
|
|
@@ -12,8 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**defaultValue** | **string** | The default value for this parameter | [optional] [default to undefined]
|
|
13
13
|
**minValue** | **string** | The minimum value for this parameter | [optional] [default to undefined]
|
|
14
14
|
**maxValue** | **string** | The maximum value for this parameter | [optional] [default to undefined]
|
|
15
|
-
**
|
|
16
|
-
**_options** | **{ [key: string]: any; }** | Freeform options | [optional] [default to undefined]
|
|
15
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
17
16
|
|
|
18
17
|
## Example
|
|
19
18
|
|
|
@@ -27,8 +26,7 @@ const instance: RunTemplateParameterUpdateRequest = {
|
|
|
27
26
|
defaultValue,
|
|
28
27
|
minValue,
|
|
29
28
|
maxValue,
|
|
30
|
-
|
|
31
|
-
_options,
|
|
29
|
+
additionalData,
|
|
32
30
|
};
|
|
33
31
|
```
|
|
34
32
|
|
package/docs/Runner.md
CHANGED
|
@@ -18,10 +18,10 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**runTemplateId** | **string** | the Solution Run Template Id associated with this Runner | [default to undefined]
|
|
19
19
|
**organizationId** | **string** | the associated Organization Id | [readonly] [default to undefined]
|
|
20
20
|
**workspaceId** | **string** | the associated Workspace Id | [readonly] [default to undefined]
|
|
21
|
-
**ownerName** | **string** | the name of the owner | [readonly] [default to undefined]
|
|
22
21
|
**solutionName** | **string** | the Solution name | [optional] [readonly] [default to undefined]
|
|
23
22
|
**runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [readonly] [default to undefined]
|
|
24
|
-
**
|
|
23
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
24
|
+
**datasets** | [**RunnerDatasets**](RunnerDatasets.md) | definition of datasets used by the runner | [default to undefined]
|
|
25
25
|
**runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) | | [optional] [default to undefined]
|
|
26
26
|
**parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [default to undefined]
|
|
27
27
|
**lastRunInfo** | [**LastRunInfo**](LastRunInfo.md) | | [default to undefined]
|
|
@@ -46,9 +46,9 @@ const instance: Runner = {
|
|
|
46
46
|
runTemplateId,
|
|
47
47
|
organizationId,
|
|
48
48
|
workspaceId,
|
|
49
|
-
ownerName,
|
|
50
49
|
solutionName,
|
|
51
50
|
runTemplateName,
|
|
51
|
+
additionalData,
|
|
52
52
|
datasets,
|
|
53
53
|
runSizing,
|
|
54
54
|
parametersValues,
|
|
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**datasetList** | **Array<string>** | the list of Dataset Id associated to this Runner Run Template | [optional] [default to undefined]
|
|
16
16
|
**runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) | | [optional] [default to undefined]
|
|
17
17
|
**parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [optional] [default to undefined]
|
|
18
|
-
**
|
|
18
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
19
19
|
**solutionName** | **string** | the Solution name | [optional] [default to undefined]
|
|
20
20
|
**runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [default to undefined]
|
|
21
21
|
**security** | [**RunnerSecurity**](RunnerSecurity.md) | | [optional] [default to undefined]
|
|
@@ -35,7 +35,7 @@ const instance: RunnerCreateRequest = {
|
|
|
35
35
|
datasetList,
|
|
36
36
|
runSizing,
|
|
37
37
|
parametersValues,
|
|
38
|
-
|
|
38
|
+
additionalData,
|
|
39
39
|
solutionName,
|
|
40
40
|
runTemplateName,
|
|
41
41
|
security,
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**datasetList** | **Array<string>** | the list of Dataset Id associated to this Runner Run Template | [optional] [default to undefined]
|
|
14
14
|
**runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) | | [optional] [default to undefined]
|
|
15
15
|
**parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [optional] [default to undefined]
|
|
16
|
-
**
|
|
16
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
17
17
|
**solutionName** | **string** | the Solution name | [optional] [default to undefined]
|
|
18
18
|
**runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [default to undefined]
|
|
19
19
|
|
|
@@ -30,7 +30,7 @@ const instance: RunnerUpdateRequest = {
|
|
|
30
30
|
datasetList,
|
|
31
31
|
runSizing,
|
|
32
32
|
parametersValues,
|
|
33
|
-
|
|
33
|
+
additionalData,
|
|
34
34
|
solutionName,
|
|
35
35
|
runTemplateName,
|
|
36
36
|
};
|
package/docs/Workspace.md
CHANGED
|
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**createInfo** | [**WorkspaceEditInfo**](WorkspaceEditInfo.md) | The details of the Workspace creation | [default to undefined]
|
|
17
17
|
**updateInfo** | [**WorkspaceEditInfo**](WorkspaceEditInfo.md) | The details of the Workspace last update | [default to undefined]
|
|
18
18
|
**solution** | [**WorkspaceSolution**](WorkspaceSolution.md) | | [default to undefined]
|
|
19
|
-
**
|
|
19
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
20
20
|
**datasetCopy** | **boolean** | Activate the copy of dataset on scenario creation, meaning that each scenario created in this workspace will make this copy. when false, scenario use directly the dataset specified. | [optional] [default to true]
|
|
21
21
|
**security** | [**WorkspaceSecurity**](WorkspaceSecurity.md) | | [default to undefined]
|
|
22
22
|
|
|
@@ -36,7 +36,7 @@ const instance: Workspace = {
|
|
|
36
36
|
createInfo,
|
|
37
37
|
updateInfo,
|
|
38
38
|
solution,
|
|
39
|
-
|
|
39
|
+
additionalData,
|
|
40
40
|
datasetCopy,
|
|
41
41
|
security,
|
|
42
42
|
};
|
package/docs/WorkspaceApi.md
CHANGED
|
@@ -824,7 +824,7 @@ const configuration = new Configuration();
|
|
|
824
824
|
const apiInstance = new WorkspaceApi(configuration);
|
|
825
825
|
|
|
826
826
|
let organizationId: string; //The Organization identifier (default to undefined)
|
|
827
|
-
let page: number; //
|
|
827
|
+
let page: number; //Page number to query (first page is at index 0) (optional) (default to undefined)
|
|
828
828
|
let size: number; //Amount of result by page (optional) (default to undefined)
|
|
829
829
|
|
|
830
830
|
const { status, data } = await apiInstance.listWorkspaces(
|
|
@@ -839,7 +839,7 @@ const { status, data } = await apiInstance.listWorkspaces(
|
|
|
839
839
|
|Name | Type | Description | Notes|
|
|
840
840
|
|------------- | ------------- | ------------- | -------------|
|
|
841
841
|
| **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
|
|
842
|
-
| **page** | [**number**] |
|
|
842
|
+
| **page** | [**number**] | Page number to query (first page is at index 0) | (optional) defaults to undefined|
|
|
843
843
|
| **size** | [**number**] | Amount of result by page | (optional) defaults to undefined|
|
|
844
844
|
|
|
845
845
|
|
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**version** | **string** | The Workspace version MAJOR.MINOR.PATCH. | [optional] [default to undefined]
|
|
13
13
|
**tags** | **Array<string>** | The list of tags | [optional] [default to undefined]
|
|
14
14
|
**solution** | [**WorkspaceSolution**](WorkspaceSolution.md) | | [default to undefined]
|
|
15
|
-
**
|
|
15
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
16
16
|
**datasetCopy** | **boolean** | Activate the copy of dataset on scenario creation | [optional] [default to true]
|
|
17
17
|
**security** | [**WorkspaceSecurity**](WorkspaceSecurity.md) | | [optional] [default to undefined]
|
|
18
18
|
|
|
@@ -28,7 +28,7 @@ const instance: WorkspaceCreateRequest = {
|
|
|
28
28
|
version,
|
|
29
29
|
tags,
|
|
30
30
|
solution,
|
|
31
|
-
|
|
31
|
+
additionalData,
|
|
32
32
|
datasetCopy,
|
|
33
33
|
security,
|
|
34
34
|
};
|
|
@@ -9,8 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**solutionId** | **string** | The Solution Id attached to this workspace | [default to undefined]
|
|
10
10
|
**datasetId** | **string** | The Dataset Id attached to this workspace. This dataset will be used to store default values for Solution parameters with file\'s varType. | [optional] [default to undefined]
|
|
11
11
|
**defaultParameterValues** | **{ [key: string]: string; }** | A map of parameterId/value to set default values for Solution parameters with simple varType (int, string, ...) | [optional] [default to undefined]
|
|
12
|
-
**runTemplateFilter** | **Array<string>** | The list of Solution Run Template Id to filter | [optional] [default to undefined]
|
|
13
|
-
**defaultRunTemplateDataset** | **{ [key: string]: any; }** | A map of RunTemplateId/DatasetId to set a default dataset for a Run Template | [optional] [default to undefined]
|
|
14
12
|
|
|
15
13
|
## Example
|
|
16
14
|
|
|
@@ -21,8 +19,6 @@ const instance: WorkspaceSolution = {
|
|
|
21
19
|
solutionId,
|
|
22
20
|
datasetId,
|
|
23
21
|
defaultParameterValues,
|
|
24
|
-
runTemplateFilter,
|
|
25
|
-
defaultRunTemplateDataset,
|
|
26
22
|
};
|
|
27
23
|
```
|
|
28
24
|
|
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**description** | **string** | The Workspace description | [optional] [default to undefined]
|
|
12
12
|
**tags** | **Array<string>** | The list of tags | [optional] [default to undefined]
|
|
13
13
|
**solution** | [**WorkspaceSolution**](WorkspaceSolution.md) | | [optional] [default to undefined]
|
|
14
|
-
**
|
|
14
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
15
15
|
**datasetCopy** | **boolean** | Activate the copy of dataset on scenario creation | [optional] [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
@@ -25,7 +25,7 @@ const instance: WorkspaceUpdateRequest = {
|
|
|
25
25
|
description,
|
|
26
26
|
tags,
|
|
27
27
|
solution,
|
|
28
|
-
|
|
28
|
+
additionalData,
|
|
29
29
|
datasetCopy,
|
|
30
30
|
};
|
|
31
31
|
```
|
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Cosmo Tech Platform API
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.0.0-
|
|
7
|
+
* The version of the OpenAPI document: 5.0.0-rc2
|
|
8
8
|
* Contact: platform@cosmotech.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|