@cosmotech/api-ts 5.0.0-beta6 → 5.0.0-rc1
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 +119 -205
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +143 -211
- package/dist/api.js +25 -25
- 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 -0
- 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/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
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.0.0-
|
|
8
|
+
* The version of the OpenAPI document: 5.0.0-rc1
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -922,12 +922,12 @@ var DatasetApiAxiosParamCreator = function (configuration) {
|
|
|
922
922
|
* @param {string} workspaceId the Workspace identifier
|
|
923
923
|
* @param {string} datasetId the Dataset identifier
|
|
924
924
|
* @param {string} datasetPartId the Dataset part identifier
|
|
925
|
-
* @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a
|
|
926
|
-
* @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a
|
|
927
|
-
* @param {Array<string>} [avgs] Column names to average by. If you want to apply \'average\' only on distinct columns, add a
|
|
928
|
-
* @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a
|
|
929
|
-
* @param {Array<string>} [mins] Column names to min by. If you want to apply \'min\' only on distinct columns, add a
|
|
930
|
-
* @param {Array<string>} [maxs] Column names to max by. If you want to apply \'max\' only on distinct columns, add a
|
|
925
|
+
* @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
926
|
+
* @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
927
|
+
* @param {Array<string>} [avgs] Column names to average by. If you want to apply \'average\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
928
|
+
* @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
929
|
+
* @param {Array<string>} [mins] Column names to min by. If you want to apply \'min\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
930
|
+
* @param {Array<string>} [maxs] Column names to max by. If you want to apply \'max\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
931
931
|
* @param {number} [offset] The query offset
|
|
932
932
|
* @param {number} [limit] The query limit
|
|
933
933
|
* @param {Array<string>} [groupBys] Column names to group by
|
|
@@ -1830,12 +1830,12 @@ var DatasetApiFp = function (configuration) {
|
|
|
1830
1830
|
* @param {string} workspaceId the Workspace identifier
|
|
1831
1831
|
* @param {string} datasetId the Dataset identifier
|
|
1832
1832
|
* @param {string} datasetPartId the Dataset part identifier
|
|
1833
|
-
* @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a
|
|
1834
|
-
* @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a
|
|
1835
|
-
* @param {Array<string>} [avgs] Column names to average by. If you want to apply \'average\' only on distinct columns, add a
|
|
1836
|
-
* @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a
|
|
1837
|
-
* @param {Array<string>} [mins] Column names to min by. If you want to apply \'min\' only on distinct columns, add a
|
|
1838
|
-
* @param {Array<string>} [maxs] Column names to max by. If you want to apply \'max\' only on distinct columns, add a
|
|
1833
|
+
* @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
1834
|
+
* @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
1835
|
+
* @param {Array<string>} [avgs] Column names to average by. If you want to apply \'average\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
1836
|
+
* @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
1837
|
+
* @param {Array<string>} [mins] Column names to min by. If you want to apply \'min\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
1838
|
+
* @param {Array<string>} [maxs] Column names to max by. If you want to apply \'max\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
1839
1839
|
* @param {number} [offset] The query offset
|
|
1840
1840
|
* @param {number} [limit] The query limit
|
|
1841
1841
|
* @param {Array<string>} [groupBys] Column names to group by
|
|
@@ -2234,12 +2234,12 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
|
|
|
2234
2234
|
* @param {string} workspaceId the Workspace identifier
|
|
2235
2235
|
* @param {string} datasetId the Dataset identifier
|
|
2236
2236
|
* @param {string} datasetPartId the Dataset part identifier
|
|
2237
|
-
* @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a
|
|
2238
|
-
* @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a
|
|
2239
|
-
* @param {Array<string>} [avgs] Column names to average by. If you want to apply \'average\' only on distinct columns, add a
|
|
2240
|
-
* @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a
|
|
2241
|
-
* @param {Array<string>} [mins] Column names to min by. If you want to apply \'min\' only on distinct columns, add a
|
|
2242
|
-
* @param {Array<string>} [maxs] Column names to max by. If you want to apply \'max\' only on distinct columns, add a
|
|
2237
|
+
* @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2238
|
+
* @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2239
|
+
* @param {Array<string>} [avgs] Column names to average by. If you want to apply \'average\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2240
|
+
* @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2241
|
+
* @param {Array<string>} [mins] Column names to min by. If you want to apply \'min\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2242
|
+
* @param {Array<string>} [maxs] Column names to max by. If you want to apply \'max\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2243
2243
|
* @param {number} [offset] The query offset
|
|
2244
2244
|
* @param {number} [limit] The query limit
|
|
2245
2245
|
* @param {Array<string>} [groupBys] Column names to group by
|
|
@@ -2564,12 +2564,12 @@ var DatasetApi = /** @class */ (function (_super) {
|
|
|
2564
2564
|
* @param {string} workspaceId the Workspace identifier
|
|
2565
2565
|
* @param {string} datasetId the Dataset identifier
|
|
2566
2566
|
* @param {string} datasetPartId the Dataset part identifier
|
|
2567
|
-
* @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a
|
|
2568
|
-
* @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a
|
|
2569
|
-
* @param {Array<string>} [avgs] Column names to average by. If you want to apply \'average\' only on distinct columns, add a
|
|
2570
|
-
* @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a
|
|
2571
|
-
* @param {Array<string>} [mins] Column names to min by. If you want to apply \'min\' only on distinct columns, add a
|
|
2572
|
-
* @param {Array<string>} [maxs] Column names to max by. If you want to apply \'max\' only on distinct columns, add a
|
|
2567
|
+
* @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2568
|
+
* @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2569
|
+
* @param {Array<string>} [avgs] Column names to average by. If you want to apply \'average\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2570
|
+
* @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2571
|
+
* @param {Array<string>} [mins] Column names to min by. If you want to apply \'min\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2572
|
+
* @param {Array<string>} [maxs] Column names to max by. If you want to apply \'max\' only on distinct columns, add a * at the end of the column name (e.g. stock*).
|
|
2573
2573
|
* @param {number} [offset] The query offset
|
|
2574
2574
|
* @param {number} [limit] The query limit
|
|
2575
2575
|
* @param {Array<string>} [groupBys] Column names to group by
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.0.0-
|
|
5
|
+
* The version of the OpenAPI document: 5.0.0-rc1
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.0.0-
|
|
8
|
+
* The version of the OpenAPI document: 5.0.0-rc1
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.0.0-
|
|
5
|
+
* The version of the OpenAPI document: 5.0.0-rc1
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.0.0-
|
|
8
|
+
* The version of the OpenAPI document: 5.0.0-rc1
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.0.0-
|
|
5
|
+
* The version of the OpenAPI document: 5.0.0-rc1
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.0.0-
|
|
8
|
+
* The version of the OpenAPI document: 5.0.0-rc1
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.0.0-
|
|
5
|
+
* The version of the OpenAPI document: 5.0.0-rc1
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.0.0-
|
|
8
|
+
* The version of the OpenAPI document: 5.0.0-rc1
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/Dataset.md
CHANGED
|
@@ -12,9 +12,10 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**organizationId** | **string** | the associated Organization Id | [readonly] [default to undefined]
|
|
13
13
|
**workspaceId** | **string** | the associated Workspace Id | [readonly] [default to undefined]
|
|
14
14
|
**tags** | **Array<string>** | the list of tags | [default to undefined]
|
|
15
|
+
**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
|
|
15
16
|
**parts** | [**Array<DatasetPart>**](DatasetPart.md) | | [default to undefined]
|
|
16
|
-
**createInfo** | [**
|
|
17
|
-
**updateInfo** | [**
|
|
17
|
+
**createInfo** | [**DatasetEditInfo**](DatasetEditInfo.md) | The details of the Dataset creation | [default to undefined]
|
|
18
|
+
**updateInfo** | [**DatasetEditInfo**](DatasetEditInfo.md) | The details of the Dataset last update | [default to undefined]
|
|
18
19
|
**security** | [**DatasetSecurity**](DatasetSecurity.md) | | [default to undefined]
|
|
19
20
|
|
|
20
21
|
## Example
|
|
@@ -29,6 +30,7 @@ const instance: Dataset = {
|
|
|
29
30
|
organizationId,
|
|
30
31
|
workspaceId,
|
|
31
32
|
tags,
|
|
33
|
+
additionalData,
|
|
32
34
|
parts,
|
|
33
35
|
createInfo,
|
|
34
36
|
updateInfo,
|
package/docs/DatasetApi.md
CHANGED
|
@@ -699,7 +699,6 @@ const { status, data } = await apiInstance.listDatasetParts(
|
|
|
699
699
|
|**200** | List of dataset parts | - |
|
|
700
700
|
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
701
701
|
|**404** | Dataset specified is not found | - |
|
|
702
|
-
|**422** | Targeted dataset do not support requests | - |
|
|
703
702
|
|
|
704
703
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
705
704
|
|
|
@@ -841,12 +840,12 @@ let organizationId: string; //the Organization identifier (default to undefined)
|
|
|
841
840
|
let workspaceId: string; //the Workspace identifier (default to undefined)
|
|
842
841
|
let datasetId: string; //the Dataset identifier (default to undefined)
|
|
843
842
|
let datasetPartId: string; //the Dataset part identifier (default to undefined)
|
|
844
|
-
let selects: Array<string>; //Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a
|
|
845
|
-
let sums: Array<string>; //Column names to sum by. If you want to sum only distinct columns, add a
|
|
846
|
-
let avgs: Array<string>; //Column names to average by. If you want to apply \'average\' only on distinct columns, add a
|
|
847
|
-
let counts: Array<string>; //Column names to count by. If you want to count only distinct columns, add a
|
|
848
|
-
let mins: Array<string>; //Column names to min by. If you want to apply \'min\' only on distinct columns, add a
|
|
849
|
-
let maxs: Array<string>; //Column names to max by. If you want to apply \'max\' only on distinct columns, add a
|
|
843
|
+
let selects: Array<string>; //Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*). (optional) (default to undefined)
|
|
844
|
+
let sums: Array<string>; //Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*). (optional) (default to undefined)
|
|
845
|
+
let avgs: Array<string>; //Column names to average by. If you want to apply \'average\' only on distinct columns, add a * at the end of the column name (e.g. stock*). (optional) (default to undefined)
|
|
846
|
+
let counts: Array<string>; //Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*). (optional) (default to undefined)
|
|
847
|
+
let mins: Array<string>; //Column names to min by. If you want to apply \'min\' only on distinct columns, add a * at the end of the column name (e.g. stock*). (optional) (default to undefined)
|
|
848
|
+
let maxs: Array<string>; //Column names to max by. If you want to apply \'max\' only on distinct columns, add a * at the end of the column name (e.g. stock*). (optional) (default to undefined)
|
|
850
849
|
let offset: number; //The query offset (optional) (default to undefined)
|
|
851
850
|
let limit: number; //The query limit (optional) (default to undefined)
|
|
852
851
|
let groupBys: Array<string>; //Column names to group by (optional) (default to undefined)
|
|
@@ -878,12 +877,12 @@ const { status, data } = await apiInstance.queryData(
|
|
|
878
877
|
| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
|
|
879
878
|
| **datasetId** | [**string**] | the Dataset identifier | defaults to undefined|
|
|
880
879
|
| **datasetPartId** | [**string**] | the Dataset part identifier | defaults to undefined|
|
|
881
|
-
| **selects** | **Array<string>** | Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a
|
|
882
|
-
| **sums** | **Array<string>** | Column names to sum by. If you want to sum only distinct columns, add a
|
|
883
|
-
| **avgs** | **Array<string>** | Column names to average by. If you want to apply \'average\' only on distinct columns, add a
|
|
884
|
-
| **counts** | **Array<string>** | Column names to count by. If you want to count only distinct columns, add a
|
|
885
|
-
| **mins** | **Array<string>** | Column names to min by. If you want to apply \'min\' only on distinct columns, add a
|
|
886
|
-
| **maxs** | **Array<string>** | Column names to max by. If you want to apply \'max\' only on distinct columns, add a
|
|
880
|
+
| **selects** | **Array<string>** | Column names that should be part of the response data. You can specify a column name like: - id - stock - quantity - ... If you want to select only distinct columns, add a * at the end of the column name (e.g. stock*). | (optional) defaults to undefined|
|
|
881
|
+
| **sums** | **Array<string>** | Column names to sum by. If you want to sum only distinct columns, add a * at the end of the column name (e.g. stock*). | (optional) defaults to undefined|
|
|
882
|
+
| **avgs** | **Array<string>** | Column names to average by. If you want to apply \'average\' only on distinct columns, add a * at the end of the column name (e.g. stock*). | (optional) defaults to undefined|
|
|
883
|
+
| **counts** | **Array<string>** | Column names to count by. If you want to count only distinct columns, add a * at the end of the column name (e.g. stock*). | (optional) defaults to undefined|
|
|
884
|
+
| **mins** | **Array<string>** | Column names to min by. If you want to apply \'min\' only on distinct columns, add a * at the end of the column name (e.g. stock*). | (optional) defaults to undefined|
|
|
885
|
+
| **maxs** | **Array<string>** | Column names to max by. If you want to apply \'max\' only on distinct columns, add a * at the end of the column name (e.g. stock*). | (optional) defaults to undefined|
|
|
887
886
|
| **offset** | [**number**] | The query offset | (optional) defaults to undefined|
|
|
888
887
|
| **limit** | [**number**] | The query limit | (optional) defaults to undefined|
|
|
889
888
|
| **groupBys** | **Array<string>** | Column names to group by | (optional) defaults to undefined|
|
|
@@ -978,9 +977,9 @@ const { status, data } = await apiInstance.replaceDatasetPart(
|
|
|
978
977
|
| Status code | Description | Response headers |
|
|
979
978
|
|-------------|-------------|------------------|
|
|
980
979
|
|**200** | Dataset part successfully replaced | - |
|
|
980
|
+
|**400** | Bad request | - |
|
|
981
981
|
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
982
982
|
|**404** | Dataset part specified is not found | - |
|
|
983
|
-
|**422** | Targeted dataset do not support requests | - |
|
|
984
983
|
|
|
985
984
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
986
985
|
|
|
@@ -1046,6 +1045,9 @@ const { status, data } = await apiInstance.searchDatasetParts(
|
|
|
1046
1045
|
| Status code | Description | Response headers |
|
|
1047
1046
|
|-------------|-------------|------------------|
|
|
1048
1047
|
|**200** | Dataset part list containing tags | - |
|
|
1048
|
+
|**400** | Bad request | - |
|
|
1049
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
1050
|
+
|**404** | Dataset specified is not found or you don\'t have access to it | - |
|
|
1049
1051
|
|
|
1050
1052
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1051
1053
|
|
|
@@ -1108,6 +1110,8 @@ const { status, data } = await apiInstance.searchDatasets(
|
|
|
1108
1110
|
| Status code | Description | Response headers |
|
|
1109
1111
|
|-------------|-------------|------------------|
|
|
1110
1112
|
|**200** | Dataset list containing tags | - |
|
|
1113
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
1114
|
+
|**404** | Organization, workspace or dataset specified is not found | - |
|
|
1111
1115
|
|
|
1112
1116
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1113
1117
|
|
|
@@ -1363,9 +1367,9 @@ const { status, data } = await apiInstance.updateDatasetPart(
|
|
|
1363
1367
|
| Status code | Description | Response headers |
|
|
1364
1368
|
|-------------|-------------|------------------|
|
|
1365
1369
|
|**200** | Dataset part information successfully updated | - |
|
|
1370
|
+
|**400** | Bad request | - |
|
|
1366
1371
|
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
1367
1372
|
|**404** | Dataset part specified is not found | - |
|
|
1368
|
-
|**422** | Targeted dataset do not support requests | - |
|
|
1369
1373
|
|
|
1370
1374
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1371
1375
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# DatasetCreateInfo
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**timestamp** | **number** | The timestamp of the creation in millisecond | [default to undefined]
|
|
9
|
+
**userId** | **string** | The id of the user who did the creation | [default to undefined]
|
|
10
|
+
**runnerId** | **string** | The runner id which has created the dataset (nullable) | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { DatasetCreateInfo } from '@cosmotech/api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: DatasetCreateInfo = {
|
|
18
|
+
timestamp,
|
|
19
|
+
userId,
|
|
20
|
+
runnerId,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -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,6 +9,7 @@ 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
14
|
**security** | [**DatasetSecurity**](DatasetSecurity.md) | | [optional] [default to undefined]
|
|
14
15
|
|
|
@@ -21,6 +22,7 @@ const instance: DatasetUpdateRequest = {
|
|
|
21
22
|
name,
|
|
22
23
|
description,
|
|
23
24
|
tags,
|
|
25
|
+
additionalData,
|
|
24
26
|
parts,
|
|
25
27
|
security,
|
|
26
28
|
};
|
|
@@ -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
|
};
|