unecessary 'required' property in Solution openapi removed

Author: vcarluer

doc/Models/RunTemplate.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | the Solution Run Template id | [default to null]
-**name** | **String** | the Run Template name | [default to null]
+**name** | **String** | the Run Template name | [optional] [default to null]
 **description** | **String** | the Run Template description | [optional] [default to null]
 **csmSimulation** | **String** | the Cosmo Tech simulation name. This information is send to the Engine. Mandatory information if no Engine is defined | [optional] [default to null]
 **tags** | **List** | the list of Run Template tags | [optional] [default to null]

doc/Models/RunTemplateParameter.md

@@ -4,8 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | the Parameter id | [default to null]
-**labels** | **Map** | a translated label with key as ISO 639-1 code | [default to null]
-**varType** | **String** | the variable type for the parameter. Basic types or special type %DATASETID% | [default to null]
+**labels** | **Map** | a translated label with key as ISO 639-1 code | [optional] [default to null]
+**varType** | **String** | the variable type for the parameter. Basic types or special type %DATASETID% | [optional] [default to null]
 **defaultValue** | **String** | the default value for this parameter | [optional] [default to null]
 **minValue** | **String** | the minimum value for this parameter | [optional] [default to null]
 **maxValue** | **String** | the maximum value for this parameter | [optional] [default to null]

doc/Models/RunTemplateParameterGroup.md

@@ -4,11 +4,11 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | the Parameter Group id | [default to null]
-**labels** | **Map** | a translated label with key as ISO 639-1 code | [default to null]
+**labels** | **Map** | a translated label with key as ISO 639-1 code | [optional] [default to null]
 **isTable** | **Boolean** | does the group define a table | [optional] [default to null]
 **options** | **Map** | freeform options | [optional] [default to null]
 **parentId** | **String** | the Run Template Group parent Id | [optional] [default to null]
-**parameters** | **List** | an ordered list of Run Template Parameters | [default to null]
+**parameters** | **List** | an ordered list of Run Template Parameters | [optional] [default to null]
 
 [[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/Models/Solution.md

@@ -4,19 +4,19 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | the Solution version unique identifier | [optional] [default to null]
-**key** | **String** | the Solution key which group Solution versions | [default to null]
-**name** | **String** | the Solution name | [default to null]
+**key** | **String** | the Solution key which group Solution versions | [optional] [default to null]
+**name** | **String** | the Solution name | [optional] [default to null]
 **description** | **String** | the Solution description | [optional] [default to null]
-**repository** | **String** | the registry repository containing the image | [default to null]
+**repository** | **String** | the registry repository containing the image | [optional] [default to null]
 **csmSimulator** | **String** | the main Cosmo Tech simulator name used in standard Run Template | [optional] [default to null]
-**version** | **String** | the Solution version MAJOR.MINOR.PATCH. Must be aligned with an existing repository tag | [default to null]
+**version** | **String** | the Solution version MAJOR.MINOR.PATCH. Must be aligned with an existing repository tag | [optional] [default to null]
 **ownerId** | **String** | the User id which own this Solution | [optional] [default to null]
 **sdkVersion** | **String** | the MAJOR.MINOR version used to build this solution | [optional] [default to null]
 **url** | **String** | an optional URL link to solution page | [optional] [default to null]
 **tags** | **List** | the list of tags | [optional] [default to null]
 **parameters** | [**List**](RunTemplateParameter.md) | the list of Run Template Parameters | [optional] [default to null]
 **parameterGroups** | [**List**](RunTemplateParameterGroup.md) | the list of parameters groups for the Run Templates | [optional] [default to null]
-**runTemplates** | [**List**](RunTemplate.md) | list of Run Template | [default to null]
+**runTemplates** | [**List**](RunTemplate.md) | list of Run Template | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

openapi/plantuml/schemas.plantuml

@@ -98,7 +98,7 @@ entity OrganizationUser {
 
 entity RunTemplate {
     * id: String
-    * name: String
+    name: String
     description: String
     csmSimulation: String
     tags: List<String>
@@ -134,8 +134,8 @@ entity RunTemplateHandlerId {
 
 entity RunTemplateParameter {
     * id: String
-    * labels: Map
-    * varType: String
+    labels: Map
+    varType: String
     defaultValue: String
     minValue: String
     maxValue: String
@@ -145,11 +145,11 @@ entity RunTemplateParameter {
 
 entity RunTemplateParameterGroup {
     * id: String
-    * labels: Map
+    labels: Map
     isTable: Boolean
     options: Map
     parentId: String
-    * parameters: List<String>
+    parameters: List<String>
 }
 
 entity RunTemplateParameterValue {
@@ -342,19 +342,19 @@ entity ScenarioValidationStatus {
 
 entity Solution {
     id: String
-    * key: String
-    * name: String
+    key: String
+    name: String
     description: String
-    * repository: String
+    repository: String
     csmSimulator: String
-    * version: String
+    version: String
     ownerId: String
     sdkVersion: String
     url: String
     tags: List<String>
     parameters: List<RunTemplateParameter>
     parameterGroups: List<RunTemplateParameterGroup>
-    * runTemplates: List<RunTemplate>
+    runTemplates: List<RunTemplate>
 }
 
 entity User {

scenario/src/main/kotlin/com/cosmotech/scenario/azure/ScenarioServiceImpl.kt

@@ -233,7 +233,7 @@ internal class ScenarioServiceImpl(
             ?.filter { parameterGroup ->
               runTemplate?.parameterGroups?.contains(parameterGroup.id) == true
             }
-            ?.flatMap { parameterGroup -> parameterGroup.parameters }
+            ?.flatMap { parameterGroup -> parameterGroup?.parameters ?: mutableListOf() }
     if (!runTemplateParametersIds.isNullOrEmpty()) {
       val parentParameters = parent.parametersValues?.associate { it.parameterId to it }
       val scenarioParameters = scenario.parametersValues?.associate { it.parameterId to it }

scenariorun/src/main/kotlin/com/cosmotech/scenariorun/ContainerFactory.kt

@@ -1008,7 +1008,9 @@ internal class ContainerFactory(
   }
 
   private fun getRunTemplate(solution: Solution, runTemplateId: String): RunTemplate {
-    return solution.runTemplates.find { runTemplate -> runTemplate.id == runTemplateId }
+    return (solution.runTemplates ?: mutableListOf()).find { runTemplate ->
+      runTemplate.id == runTemplateId
+    }
         ?: throw IllegalStateException(
             "runTemplateId $runTemplateId not found in Solution ${solution.id}")
   }
@@ -1026,7 +1028,6 @@ internal class ContainerFactory(
   ): ScenarioRunContainer {
 
     if (step == null) throw IllegalStateException("Solution Container Step Spec is not defined")
-    val template = getRunTemplate(solution, runTemplateId)
     val imageName =
         getImageName(
             csmPlatformProperties.azure?.containerRegistries?.solutions ?: "",
@@ -1045,6 +1046,7 @@ internal class ContainerFactory(
 
     envVars.putAll(getEventHubEnvVars(organization, workspace))
 
+    val template = getRunTemplate(solution, runTemplateId)
     val csmSimulation = template.csmSimulation
     if (csmSimulation != null) {
       envVars[CSM_SIMULATION_VAR] = csmSimulation
@@ -1248,8 +1250,10 @@ internal class ContainerFactory(
         }
       }
 
-  private fun getImageName(registry: String, repository: String, version: String? = null): String {
-    val repoVersion = if (version == null) repository else "${repository}:${version}"
+  private fun getImageName(registry: String, repository: String?, version: String? = null): String {
+    if (repository == null) throw IllegalStateException("Solution repository is not defined")
+    val repo = repository ?: "ERROR"
+    val repoVersion = if (version == null) repo else "${repo}:${version}"
     return if (registry != "") "${registry}/${repoVersion}" else repoVersion
   }
 }

scenariorun/src/main/kotlin/com/cosmotech/scenariorun/dataset/DatasetUtils.kt

@@ -32,10 +32,12 @@ internal fun findDatasetsAndConnectors(
     addDatasetAndConnector(
         datasetService, connectorService, organizationId, datasetId, datasets, connectors)
   }
-  val parameterGroupIds = runTemplate.parameterGroups
+  val parameterGroupIds = runTemplate.parameterGroups ?: listOf()
   if (parameterGroupIds != null) {
     val parametersIds =
-        (solution.parameterGroups?.filter { it.id in parameterGroupIds }?.map { it.parameters })
+        (solution.parameterGroups?.filter { it.id in parameterGroupIds }?.map {
+              it.parameters ?: listOf()
+            })
             ?.flatten()
     if (parametersIds != null) {
       solution

solution/src/main/kotlin/com/cosmotech/solution/azure/SolutionServiceImpl.kt

@@ -122,7 +122,8 @@ internal class SolutionServiceImpl(
     }
 
     val existingSolution = findSolutionById(organizationId, solutionId)
-    val runTemplateMap = existingSolution.runTemplates.associateBy { it.id }.toMutableMap()
+    val runTemplateMap =
+        existingSolution.runTemplates?.associateBy { it.id }?.toMutableMap() ?: mutableMapOf()
     runTemplateMap.putAll(runTemplate.filter { it.id.isNotBlank() }.associateBy { it.id })
     existingSolution.runTemplates = runTemplateMap.values.toMutableList()
     cosmosTemplate.upsert("${organizationId}_solutions", existingSolution)
@@ -153,7 +154,7 @@ internal class SolutionServiceImpl(
       runTemplateId: String
   ) {
     val existingSolution = findSolutionById(organizationId, solutionId)
-    if (!existingSolution.runTemplates.removeIf { it.id == runTemplateId }) {
+    if (!(existingSolution.runTemplates?.removeIf { it.id == runTemplateId } ?: true)) {
       throw CsmResourceNotFoundException("Run Template '$runTemplateId' *not* found")
     }
     cosmosTemplate.upsert("${organizationId}_solutions", existingSolution)
@@ -198,7 +199,8 @@ internal class SolutionServiceImpl(
   ): List<RunTemplate> {
     val existingSolution = findSolutionById(organizationId, solutionId)
     val runTemplates =
-        existingSolution.runTemplates.filter { it.id == runTemplateId }.toMutableList()
+        existingSolution.runTemplates?.filter { it.id == runTemplateId }?.toMutableList()
+            ?: mutableListOf()
     if (runTemplates.isEmpty()) {
       throw CsmResourceNotFoundException("Run Template '$runTemplateId' *not* found")
     }
@@ -261,17 +263,20 @@ internal class SolutionServiceImpl(
             "${solutionId.sanitizeForAzureStorage()}/$runTemplateId/${handlerId.value}.zip")
         .upload(body.inputStream, body.contentLength(), overwrite)
 
-    val runTemplate = solution.runTemplates.findLast { it.id == runTemplateId }!!
+    val runTemplate = solution.runTemplates?.findLast { it.id == runTemplateId }
+    if (runTemplate == null) {
+      throw CsmResourceNotFoundException("Run Template '$runTemplateId' *not* found")
+    }
     when (handlerId) {
       RunTemplateHandlerId.parameters_handler ->
-          runTemplate.parametersHandlerSource = RunTemplateStepSource.cloud
+          runTemplate!!.parametersHandlerSource = RunTemplateStepSource.cloud
       RunTemplateHandlerId.validator ->
-          runTemplate.datasetValidatorSource = RunTemplateStepSource.cloud
-      RunTemplateHandlerId.prerun -> runTemplate.preRunSource = RunTemplateStepSource.cloud
-      RunTemplateHandlerId.engine -> runTemplate.runSource = RunTemplateStepSource.cloud
-      RunTemplateHandlerId.postrun -> runTemplate.postRunSource = RunTemplateStepSource.cloud
+          runTemplate!!.datasetValidatorSource = RunTemplateStepSource.cloud
+      RunTemplateHandlerId.prerun -> runTemplate!!.preRunSource = RunTemplateStepSource.cloud
+      RunTemplateHandlerId.engine -> runTemplate!!.runSource = RunTemplateStepSource.cloud
+      RunTemplateHandlerId.postrun -> runTemplate!!.postRunSource = RunTemplateStepSource.cloud
       RunTemplateHandlerId.scenariodata_transform ->
-          runTemplate.scenariodataTransformSource = RunTemplateStepSource.cloud
+          runTemplate!!.scenariodataTransformSource = RunTemplateStepSource.cloud
     }.run {
       // This trick forces Kotlin to raise an error at compile time if the "when" statement is not
       // exhaustive
@@ -308,7 +313,7 @@ internal class SolutionServiceImpl(
       runTemplateId: String,
   ): Solution {
     val solution = findSolutionById(organizationId, solutionId)
-    val validRunTemplateIds = solution.runTemplates.map { it.id }.toSet()
+    val validRunTemplateIds = solution.runTemplates?.map { it.id }?.toSet() ?: setOf()
     if (validRunTemplateIds.isEmpty()) {
       throw IllegalArgumentException(
           "Solution $solutionId does not declare any run templates. " +

solution/src/main/openapi/solution.yaml

@@ -533,12 +533,12 @@ components:
           description: list of Run Template
           items:
             $ref: '#/components/schemas/RunTemplate'
-      required:
-        - key
-        - name
-        - repository
-        - version
-        - runTemplates
+  #       required:
+  #         - key
+  #         - name
+  #         - repository
+  #         - version
+  #         - runTemplates
     RunTemplate:
       type: object
       description: a Solution Run Template
@@ -634,7 +634,7 @@ components:
           description: an optional duration in seconds in which a workflow is allowed to run
       required:
         - id
-        - name
+#         - name
     RunTemplateHandlerId:
       type: string
       description: the Run Template step handler identifier
@@ -670,8 +670,8 @@ components:
             description: a Run Template Parameter id
       required:
         - id
-        - labels
-        - parameters
+#         - labels
+#         - parameters
     RunTemplateParameter:
       type: object
       description: a Run Template Parameter
@@ -702,8 +702,8 @@ components:
           additionalProperties: true
       required:
         - id
-        - labels
-        - varType
+#         - labels
+#         - varType
     TranslatedLabels:
       type: object
       description: a translated label with key as ISO 639-1 code