Skip to content

Commit 0751bb1

Browse files
Leopold-CramerLeopold-Cramer
committed
add missing yaml and json usability for solution endpoints + add make properties requirements more precise
1 parent dbea4e7 commit 0751bb1

File tree

16 files changed

+159
-186
lines changed

16 files changed

+159
-186
lines changed

‎doc/.openapi-generator/FILES

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ Models/DatasetTwinGraphHash.md
2424
Models/DatasetTwinGraphInfo.md
2525
Models/DatasetTwinGraphQuery.md
2626
Models/Dataset_connector.md
27-
Models/DeleteHistoricalData.md
2827
Models/FileUploadMetadata.md
2928
Models/FileUploadValidation.md
3029
Models/GraphProperties.md

‎doc/Apis/SolutionApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@ Update solution access control
421421

422422
### HTTP request headers
423423

424-
- **Content-Type**: application/json
424+
- **Content-Type**: application/json, application/yaml
425425
- **Accept**: application/json
426426

427427
<a name="updateSolutionDefaultSecurity"></a>
@@ -475,7 +475,7 @@ Update solution parameter groups
475475

476476
### HTTP request headers
477477

478-
- **Content-Type**: application/json
478+
- **Content-Type**: application/json, application/yaml
479479
- **Accept**: application/json
480480

481481
<a name="updateSolutionParameters"></a>
@@ -502,7 +502,7 @@ Update solution parameters
502502

503503
### HTTP request headers
504504

505-
- **Content-Type**: application/json
505+
- **Content-Type**: application/json, application/yaml
506506
- **Accept**: application/json
507507

508508
<a name="updateSolutionRunTemplate"></a>
@@ -557,6 +557,6 @@ Update solution run templates
557557

558558
### HTTP request headers
559559

560-
- **Content-Type**: application/json
560+
- **Content-Type**: application/json, application/yaml
561561
- **Accept**: application/json
562562

‎doc/Models/RunTemplate.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,6 @@
1212
| **computeSize** | **String** | The compute size needed for this Run Template | [optional] [default to null] |
1313
| **runSizing** | [**RunTemplateResourceSizing**](RunTemplateResourceSizing.md) | | [optional] [default to null] |
1414
| **noDataIngestionState** | **Boolean** | Set to true if the run template does not want to check data ingestion state | [optional] [default to null] |
15-
| **fetchDatasets** | **Boolean** | Whether or not the fetch dataset step is done | [optional] [default to null] |
16-
| **scenarioDataDownloadTransform** | **Boolean** | Whether or not the scenario data download transform step is done | [optional] [default to null] |
17-
| **fetchScenarioParameters** | **Boolean** | Whether or not the fetch parameters step is done | [optional] [default to null] |
18-
| **applyParameters** | **Boolean** | Whether or not the apply parameter step is done | [optional] [default to null] |
19-
| **validateData** | **Boolean** | Whether or not the validate step is done | [optional] [default to null] |
20-
| **sendDatasetsToDataWarehouse** | **Boolean** | Whether or not the Datasets values are sent to the DataWarehouse | [optional] [default to null] |
21-
| **sendInputParametersToDataWarehouse** | **Boolean** | Whether or not the input parameters values are sent to the DataWarehouse | [optional] [default to null] |
22-
| **preRun** | **Boolean** | Whether or not the pre-run step is done | [optional] [default to null] |
23-
| **run** | **Boolean** | Whether or not the run step is done | [optional] [default to null] |
24-
| **postRun** | **Boolean** | Whether or not the post-run step is done | [optional] [default to null] |
25-
| **parametersJson** | **Boolean** | Whether or not to store the scenario parameters in json instead of csv | [optional] [default to null] |
2615
| **parametersHandlerSource** | [**RunTemplateStepSource**](RunTemplateStepSource.md) | | [optional] [default to null] |
2716
| **datasetValidatorSource** | [**RunTemplateStepSource**](RunTemplateStepSource.md) | | [optional] [default to null] |
2817
| **preRunSource** | [**RunTemplateStepSource**](RunTemplateStepSource.md) | | [optional] [default to null] |
@@ -34,9 +23,7 @@
3423
| **gitRepositoryUrl** | **String** | An optional URL to the git repository | [optional] [default to null] |
3524
| **gitBranchName** | **String** | An optional git branch name | [optional] [default to null] |
3625
| **runTemplateSourceDir** | **String** | An optional directory where to find the run template source | [optional] [default to null] |
37-
| **orchestratorType** | [**RunTemplateOrchestrator**](RunTemplateOrchestrator.md) | | [optional] [default to null] |
3826
| **executionTimeout** | **Integer** | An optional duration in seconds in which a workflow is allowed to run | [optional] [default to null] |
39-
| **deleteHistoricalData** | [**DeleteHistoricalData**](DeleteHistoricalData.md) | | [optional] [default to null] |
4027

4128
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
4229

‎doc/Models/SolutionCreateRequest.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33

44
| Name | Type | Description | Notes |
55
|------------ | ------------- | ------------- | -------------|
6-
| **key** | **String** | The Solution key which groups Solution versions | [default to null] |
7-
| **name** | **String** | The Solution name | [default to null] |
6+
| **key** | **String** | technical key for resource name convention and version grouping. Must be unique | [default to null] |
7+
| **name** | **String** | Solution name. This name is displayed in the sample webApp | [default to null] |
88
| **description** | **String** | The Solution description | [optional] [default to null] |
99
| **repository** | **String** | The registry repository containing the image | [default to null] |
1010
| **version** | **String** | The Solution version MAJOR.MINOR.PATCH | [default to null] |
1111
| **alwaysPull** | **Boolean** | Set to true if the runtemplate wants to always pull the image | [optional] [default to false] |
1212
| **csmSimulator** | **String** | The main Cosmo Tech simulator name used in standard Run Template | [default to null] |
1313
| **tags** | **List** | The list of tags | [optional] [default to null] |
14-
| **parameters** | [**List**](RunTemplateParameter.md) | The list of Run Template Parameters | [default to null] |
15-
| **parameterGroups** | [**List**](RunTemplateParameterGroup.md) | The list of parameters groups for the Run Templates | [default to null] |
16-
| **runTemplates** | [**List**](RunTemplate.md) | List of Run Templates | [default to []] |
14+
| **parameters** | [**List**](RunTemplateParameter.md) | The list of Run Template Parameters | [optional] [default to null] |
15+
| **parameterGroups** | [**List**](RunTemplateParameterGroup.md) | The list of parameters groups for the Run Templates | [optional] [default to null] |
16+
| **runTemplates** | [**List**](RunTemplate.md) | List of Run Templates | [optional] [default to []] |
1717
| **sdkVersion** | **String** | The MAJOR.MINOR version used to build this solution | [optional] [default to null] |
1818
| **url** | **String** | An optional URL link to solution page | [optional] [default to null] |
1919
| **security** | [**SolutionSecurity**](SolutionSecurity.md) | | [optional] [default to null] |

‎doc/Models/SolutionUpdateRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
| Name | Type | Description | Notes |
55
|------------ | ------------- | ------------- | -------------|
6-
| **key** | **String** | The Solution key which groups Solution versions | [optional] [default to null] |
6+
| **key** | **String** | technical key for resource name convention and version grouping. Must be unique | [optional] [default to null] |
77
| **name** | **String** | The Solution name | [optional] [default to null] |
88
| **description** | **String** | The Solution description | [optional] [default to null] |
99
| **repository** | **String** | The registry repository containing the image | [optional] [default to null] |

‎doc/Models/WorkspaceCreateRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
| Name | Type | Description | Notes |
55
|------------ | ------------- | ------------- | -------------|
66
| **key** | **String** | technical key for resource name convention and version grouping. Must be unique | [default to null] |
7-
| **name** | **String** | Workspace name. This name is display in the sample webApp | [default to null] |
7+
| **name** | **String** | Workspace name. This name is displayed in the sample webApp | [default to null] |
88
| **description** | **String** | the Workspace description | [optional] [default to null] |
99
| **version** | **String** | the Workspace version MAJOR.MINOR.PATCH. | [optional] [default to null] |
1010
| **tags** | **List** | the list of tags | [optional] [default to null] |

‎doc/Models/WorkspaceUpdateRequest.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,12 @@
33

44
| Name | Type | Description | Notes |
55
|------------ | ------------- | ------------- | -------------|
6-
| **key** | **String** | technical key for resource name convention and version grouping. Must be unique | [default to null] |
7-
| **name** | **String** | Workspace name | [default to null] |
6+
| **key** | **String** | technical key for resource name convention and version grouping. Must be unique | [optional] [default to null] |
7+
| **name** | **String** | Workspace name | [optional] [default to null] |
88
| **description** | **String** | the Workspace description | [optional] [default to null] |
99
| **tags** | **List** | the list of tags | [optional] [default to null] |
1010
| **solution** | [**WorkspaceSolution**](WorkspaceSolution.md) | | [optional] [default to null] |
1111
| **webApp** | [**WorkspaceWebApp**](WorkspaceWebApp.md) | | [optional] [default to null] |
12-
| **sendInputToDataWarehouse** | **Boolean** | default setting for all Scenarios and Run Templates | [optional] [default to null] |
13-
| **useDedicatedEventHubNamespace** | **Boolean** | Set this property to true to use a dedicated Azure Event Hub Namespace | [optional] [default to null] |
14-
| **dedicatedEventHubSasKeyName** | **String** | the Dedicated Event Hub SAS key name | [optional] [default to null] |
15-
| **dedicatedEventHubAuthenticationStrategy** | **String** | the Event Hub authentication strategy | [optional] [default to null] |
16-
| **sendScenarioRunToEventHub** | **Boolean** | default setting for all Scenarios and Run Templates | [optional] [default to null] |
17-
| **sendScenarioMetadataToEventHub** | **Boolean** | Set this property to false to not send scenario metadata | [optional] [default to null] |
1812
| **datasetCopy** | **Boolean** | Activate the copy of dataset on scenario creation | [optional] [default to null] |
1913

2014
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎doc/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,6 @@ All URIs are relative to *http://localhost*
142142
- [DatasetTwinGraphInfo](./Models/DatasetTwinGraphInfo.md)
143143
- [DatasetTwinGraphQuery](./Models/DatasetTwinGraphQuery.md)
144144
- [Dataset_connector](./Models/Dataset_connector.md)
145-
- [DeleteHistoricalData](./Models/DeleteHistoricalData.md)
146145
- [FileUploadMetadata](./Models/FileUploadMetadata.md)
147146
- [FileUploadValidation](./Models/FileUploadValidation.md)
148147
- [GraphProperties](./Models/GraphProperties.md)

‎openapi/plantuml/schemas.plantuml

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -130,12 +130,6 @@ entity DatasetTwinGraphQuery {
130130
* query: String
131131
}
132132

133-
entity DeleteHistoricalData {
134-
* enable: Boolean
135-
pollFrequency: Integer
136-
timeOut: Integer
137-
}
138-
139133
entity FileUploadMetadata {
140134
name: String
141135
size: Integer
@@ -304,17 +298,6 @@ entity RunTemplate {
304298
computeSize: String
305299
runSizing: RunTemplateResourceSizing
306300
noDataIngestionState: Boolean
307-
fetchDatasets: Boolean
308-
scenarioDataDownloadTransform: Boolean
309-
fetchScenarioParameters: Boolean
310-
applyParameters: Boolean
311-
validateData: Boolean
312-
sendDatasetsToDataWarehouse: Boolean
313-
sendInputParametersToDataWarehouse: Boolean
314-
preRun: Boolean
315-
run: Boolean
316-
postRun: Boolean
317-
parametersJson: Boolean
318301
parametersHandlerSource: RunTemplateStepSource
319302
datasetValidatorSource: RunTemplateStepSource
320303
preRunSource: RunTemplateStepSource
@@ -326,9 +309,7 @@ entity RunTemplate {
326309
gitRepositoryUrl: String
327310
gitBranchName: String
328311
runTemplateSourceDir: String
329-
orchestratorType: RunTemplateOrchestrator
330312
executionTimeout: Integer
331-
deleteHistoricalData: DeleteHistoricalData
332313
}
333314

334315
entity RunTemplateOrchestrator {
@@ -461,9 +442,9 @@ entity SolutionCreateRequest {
461442
alwaysPull: Boolean
462443
* csmSimulator: String
463444
tags: List<String>
464-
* parameters: List<RunTemplateParameter>
465-
* parameterGroups: List<RunTemplateParameterGroup>
466-
* runTemplates: List<RunTemplate>
445+
parameters: List<RunTemplateParameter>
446+
parameterGroups: List<RunTemplateParameterGroup>
447+
runTemplates: List<RunTemplate>
467448
sdkVersion: String
468449
url: String
469450
security: SolutionSecurity
@@ -569,8 +550,8 @@ entity WorkspaceSolution {
569550
}
570551

571552
entity WorkspaceUpdateRequest {
572-
* key: String
573-
* name: String
553+
key: String
554+
name: String
574555
description: String
575556
tags: List<String>
576557
solution: WorkspaceSolution
@@ -614,7 +595,6 @@ RunStatus -- "0..*" RunStatusNode : nodes
614595
FileUploadValidation -- "0..*" FileUploadMetadata : nodes
615596
FileUploadValidation -- "0..*" FileUploadMetadata : edges
616597
RunTemplate -- RunTemplateResourceSizing : runSizing
617-
RunTemplate -- DeleteHistoricalData : deleteHistoricalData
618598
RunnerSecurity -- "0..*" RunnerAccessControl : accessControlList
619599
RunStatusNode -- RunResourceRequested : resourcesDuration
620600
WorkspaceUpdateRequest -- WorkspaceSolution : solution

‎run/src/main/kotlin/com/cosmotech/run/RunContainerFactory.kt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,11 +175,9 @@ class RunContainerFactory(
175175
val runTemplateId =
176176
runner.runTemplateId ?: throw IllegalStateException("Runner runTemplateId cannot be null")
177177

178-
val solutionRepository =
179-
solution.repository
180178
val imageName =
181179
getImageName(
182-
csmPlatformProperties.containerRegistry.host, solutionRepository, solution.version)
180+
csmPlatformProperties.containerRegistry.host, solution.repository, solution.version)
183181

184182
val envVars =
185183
getCommonEnvVars(

0 commit comments

Comments
 (0)