@cosmotech/api-ts 5.0.0-beta4 → 5.0.0-beta6

package/docs/RunApi.md

@@ -9,8 +9,6 @@ All URIs are relative to *http://localhost:8080*
 |[**getRunLogs**](#getrunlogs) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run|
 |[**getRunStatus**](#getrunstatus) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run|
 |[**listRuns**](#listruns) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner|
-|[**queryRunData**](#queryrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query | query the run data|
-|[**sendRunData**](#sendrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send | Send data associated to a run|
 
 # **deleteRun**
 > deleteRun()
@@ -313,130 +311,3 @@ const { status, data } = await apiInstance.listRuns(
 
 [[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)
 
-# **queryRunData**
-> QueryResult queryRunData(runDataQuery)
-
-
-### Example
-
-```typescript
-import {
-    RunApi,
-    Configuration,
-    RunDataQuery
-} from '@cosmotech/api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new RunApi(configuration);
-
-let organizationId: string; //the Organization identifier (default to undefined)
-let workspaceId: string; //the Workspace identifier (default to undefined)
-let runnerId: string; //the Runner identifier (default to undefined)
-let runId: string; //the Run identifier (default to undefined)
-let runDataQuery: RunDataQuery; //the query to run
-
-const { status, data } = await apiInstance.queryRunData(
-    organizationId,
-    workspaceId,
-    runnerId,
-    runId,
-    runDataQuery
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **runDataQuery** | **RunDataQuery**| the query to run | |
-| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
-| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
-| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
-| **runId** | [**string**] | the Run identifier | defaults to undefined|
-
-
-### Return type
-
-**QueryResult**
-
-### Authorization
-
-[oAuth2AuthCode](../README.md#oAuth2AuthCode)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, application/yaml
- - **Accept**: application/json, application/yaml
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | the query response |  -  |
-
-[[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)
-
-# **sendRunData**
-> RunData sendRunData(sendRunDataRequest)
-
-
-### Example
-
-```typescript
-import {
-    RunApi,
-    Configuration,
-    SendRunDataRequest
-} from '@cosmotech/api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new RunApi(configuration);
-
-let organizationId: string; //the Organization identifier (default to undefined)
-let workspaceId: string; //the Workspace identifier (default to undefined)
-let runnerId: string; //the Runner identifier (default to undefined)
-let runId: string; //the Run identifier (default to undefined)
-let sendRunDataRequest: SendRunDataRequest; //Custom data to register
-
-const { status, data } = await apiInstance.sendRunData(
-    organizationId,
-    workspaceId,
-    runnerId,
-    runId,
-    sendRunDataRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **sendRunDataRequest** | **SendRunDataRequest**| Custom data to register | |
-| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
-| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
-| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
-| **runId** | [**string**] | the Run identifier | defaults to undefined|
-
-
-### Return type
-
-**RunData**
-
-### Authorization
-
-[oAuth2AuthCode](../README.md#oAuth2AuthCode)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, application/yaml
- - **Accept**: application/json, application/yaml
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | Data stored |  -  |
-|**400** | Data sent format is malformed |  -  |
-
-[[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)
-

package/docs/RunData.md

@@ -1,6 +1,6 @@
 # RunData
 
-Run Data stored
+Run Data to send
 
 ## Properties
 

package/docs/RunLogs.md

@@ -0,0 +1,23 @@
+# RunLogs
+
+the output logs of a run
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**runId** | **string** | the Run Id | [readonly] [default to undefined]
+**logs** | [**Array<RunLogsEntry>**](RunLogsEntry.md) | run log entries in chronological order | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { RunLogs } from '@cosmotech/api-ts';
+
+const instance: RunLogs = {
+    runId,
+    logs,
+};
+```
+
+[[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/RunLogsEntry.md

@@ -0,0 +1,21 @@
+# RunLogsEntry
+
+single run log entry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line** | **string** | log line data | [default to undefined]
+
+## Example
+
+```typescript
+import { RunLogsEntry } from '@cosmotech/api-ts';
+
+const instance: RunLogsEntry = {
+    line,
+};
+```
+
+[[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/RunTemplateOrchestrator.md

@@ -0,0 +1,11 @@
+# RunTemplateOrchestrator
+
+the Orchestrator to use for the Run Template
+
+## Enum
+
+* `ArgoWorkflow` (value: `'argoWorkflow'`)
+
+* `CsmOrc` (value: `'csmOrc'`)
+
+[[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/RunTemplateStepSource.md

@@ -0,0 +1,15 @@
+# RunTemplateStepSource
+
+the source local, cloud or git repository
+
+## Enum
+
+* `Cloud` (value: `'cloud'`)
+
+* `Git` (value: `'git'`)
+
+* `Local` (value: `'local'`)
+
+* `Platform` (value: `'platform'`)
+
+[[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

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 **ownerName** | **string** | the name of the owner | [readonly] [default to undefined]
 **solutionName** | **string** | the Solution name | [optional] [readonly] [default to undefined]
 **runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [readonly] [default to undefined]
-**datasetList** | **Array<string>** | the list of Dataset Id associated to this Runner Run Template | [default to undefined]
+**datasets** | [**RunnerDatasets**](RunnerDatasets.md) |  | [default to undefined]
 **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) |  | [optional] [default to undefined]
 **parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [default to undefined]
 **lastRunInfo** | [**LastRunInfo**](LastRunInfo.md) |  | [default to undefined]
@@ -49,7 +49,7 @@ const instance: Runner = {
     ownerName,
     solutionName,
     runTemplateName,
-    datasetList,
+    datasets,
     runSizing,
     parametersValues,
     lastRunInfo,

package/docs/RunnerApi.md

@@ -563,8 +563,8 @@ const apiInstance = new RunnerApi(configuration);
 
 let organizationId: string; //the Organization identifier (default to undefined)
 let workspaceId: string; //the Workspace identifier (default to undefined)
-let page: number; //page number to query (first page is at index 0) (optional) (default to undefined)
-let size: number; //amount of result by page (optional) (default to undefined)
+let page: number; //Page number to query (first page is at index 0) (optional) (default to undefined)
+let size: number; //Amount of result by page (optional) (default to undefined)
 
 const { status, data } = await apiInstance.listRunners(
     organizationId,
@@ -580,8 +580,8 @@ const { status, data } = await apiInstance.listRunners(
 |------------- | ------------- | ------------- | -------------|
 | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
 | **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
-| **page** | [**number**] | page number to query (first page is at index 0) | (optional) defaults to undefined|
-| **size** | [**number**] | amount of result by page | (optional) defaults to undefined|
+| **page** | [**number**] | Page number to query (first page is at index 0) | (optional) defaults to undefined|
+| **size** | [**number**] | Amount of result by page | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/RunnerCreateRequest.md

@@ -9,15 +9,15 @@ Name | Type | Description | Notes
 **name** | **string** | the Runner name | [default to undefined]
 **description** | **string** | the Runner description | [optional] [default to undefined]
 **tags** | **Array<string>** | the list of tags | [optional] [default to undefined]
-**solutionId** | **string** | the Solution Id associated with this Runner | [readonly] [default to undefined]
+**solutionId** | **string** | the Solution Id associated with this Runner | [default to undefined]
 **parentId** | **string** | the Runner parent id | [optional] [default to undefined]
 **runTemplateId** | **string** | the Solution Run Template Id associated with this Runner | [default to undefined]
 **datasetList** | **Array<string>** | the list of Dataset Id associated to this Runner Run Template | [optional] [default to undefined]
 **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) |  | [optional] [default to undefined]
 **parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [optional] [default to undefined]
-**ownerName** | **string** | the name of the owner | [readonly] [default to undefined]
-**solutionName** | **string** | the Solution name | [optional] [readonly] [default to undefined]
-**runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [readonly] [default to undefined]
+**ownerName** | **string** | the name of the owner | [default to undefined]
+**solutionName** | **string** | the Solution name | [optional] [default to undefined]
+**runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [default to undefined]
 **security** | [**RunnerSecurity**](RunnerSecurity.md) |  | [optional] [default to undefined]
 
 ## Example

package/docs/RunnerDatasets.md

@@ -0,0 +1,24 @@
+# RunnerDatasets
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bases** | **Array<string>** | a list of Dataset Id used to build the Runner | [default to undefined]
+**parameter** | **string** | The dataset id used for dataset parameters on current Runner | [default to undefined]
+**parameters** | **Array<object>** | The dataset parts retrieved from the parameter property (programmatically fulfilled) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunnerDatasets } from '@cosmotech/api-ts';
+
+const instance: RunnerDatasets = {
+    bases,
+    parameter,
+    parameters,
+};
+```
+
+[[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/RunnerRunTemplateParameterValue.md

@@ -7,7 +7,7 @@ the value of a Solution Run Template parameter for a Runner
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **parameterId** | **string** | the parameter Id | [default to undefined]
-**varType** | **string** | the parameter value type | [optional] [readonly] [default to undefined]
+**varType** | **string** | the parameter value type | [optional] [default to undefined]
 **value** | **string** | the parameter value | [default to undefined]
 **isInherited** | **boolean** | whether or not the value is inherited from parent or has been changed | [optional] [default to undefined]
 

package/docs/RunnerUpdateRequest.md

@@ -14,8 +14,8 @@ Name | Type | Description | Notes
 **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) |  | [optional] [default to undefined]
 **parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [optional] [default to undefined]
 **ownerName** | **string** | the name of the owner | [optional] [default to undefined]
-**solutionName** | **string** | the Solution name | [optional] [readonly] [default to undefined]
-**runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [readonly] [default to undefined]
+**solutionName** | **string** | the Solution name | [optional] [default to undefined]
+**runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [default to undefined]
 
 ## Example
 

package/docs/SendRunDataRequest.md

@@ -1,13 +1,12 @@
 # SendRunDataRequest
 
-Run Data to send
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**data** | **Array<{ [key: string]: any; }>** |  | [default to undefined]
+**id** | **string** |  | [optional] [default to undefined]
+**data** | **Array<{ [key: string]: any; }>** |  | [optional] [default to undefined]
 
 ## Example