uiSchema params for overview property are overwritten by ui code

CHANGELOG.md

@@ -1,12 +1,13 @@
 <!-- markdownlint-disable MD041 -->
 ## (Unreleased)
 **BREAKING CHANGES**
-* _No changes yet_
+* Users with custom templates should update their `template_schema.json` to set `uiSchema.overview` widget to `textarea` to ensure a consistent UI experience as per ([#4860](https://github.com/microsoft/AzureTRE/pull/4860)).
 
 ENHANCEMENTS:
 * _No changes yet_
 
 BUG FIXES:
+* Fix uiSchema.overview params overwritten by ui ([#4861](https://github.com/microsoft/AzureTRE/issues/4861))
 * Fix property substitution not occuring where there is only a main step in the pipeline ([#4824](https://github.com/microsoft/AzureTRE/issues/4824))
 * Fix Mysql template ignored storage_mb ([#4846](https://github.com/microsoft/AzureTRE/issues/4846))
 * Fix duplicate `TOPIC_SUBSCRIPTION_NAME` in `core/terraform/airlock/airlock_processor.tf` ([#4847](https://github.com/microsoft/AzureTRE/pull/4847))

templates/shared_services/admin-vm/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-shared-service-admin-vm
-version: 0.5.4
+version: 0.5.5
 description: "An admin vm shared service"
 dockerfile: Dockerfile.tmpl
 registry: azuretre

templates/shared_services/admin-vm/template_schema.json

@@ -29,5 +29,10 @@
       "title": "VM SKU",
       "description": "The SKU of the VM that will be deployed."
     }
+  },
+  "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    }
   }
 }

templates/shared_services/airlock_notifier/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-shared-service-airlock-notifier
-version: 1.0.10
+version: 1.0.11
 description: "A shared service notifying on Airlock Operations"
 registry: azuretre
 dockerfile: Dockerfile.tmpl

templates/shared_services/airlock_notifier/template_schema.json

@@ -93,6 +93,9 @@
     ]
   },
   "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    },
     "smtpPassword" : {
       "ui:widget": "password"
     },

templates/shared_services/certs/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-shared-service-certs
-version: 0.7.9
+version: 0.7.10
 description: "An Azure TRE shared service to generate certificates for a specified internal domain using Letsencrypt"
 registry: azuretre
 dockerfile: Dockerfile.tmpl

templates/shared_services/certs/template_schema.json

@@ -152,5 +152,10 @@
         ]
       }
     ]
+  },
+  "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    }
   }
 }

templates/shared_services/cyclecloud/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-shared-service-cyclecloud
-version: 0.7.4
+version: 0.7.5
 description: "An Azure TRE Shared Service Template for Azure Cyclecloud"
 registry: azuretre
 dockerfile: Dockerfile.tmpl

templates/shared_services/cyclecloud/template_schema.json

@@ -28,6 +28,11 @@
       "updateable": true
     }
   },
+  "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    }
+  },
   "pipeline": {
     "install": [
       {

templates/shared_services/databricks-auth/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-shared-service-databricks-private-auth
-version: 0.1.13
+version: 0.1.14
 description: "An Azure TRE shared service for Azure Databricks authentication."
 registry: azuretre
 dockerfile: Dockerfile.tmpl

templates/shared_services/databricks-auth/template_schema.json

@@ -27,5 +27,10 @@
       "default": "Azure Databricks Private Authentication Shared Service is a Databricks workspace that in the same region as your Azure Databricks workspaces, and its only purpose is hosting the browser authentication private endpoint connection for your Azure Databricks workspace services.",
       "updateable": true
     }
+  },
+  "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    }
   }
 }

templates/shared_services/firewall/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-shared-service-firewall
-version: 1.6.1
+version: 1.6.2
 description: "An Azure TRE Firewall shared service"
 dockerfile: Dockerfile.tmpl
 registry: azuretre

templates/shared_services/firewall/template_schema.json

@@ -359,5 +359,10 @@
         }
       }
     }
+  },
+  "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    }
   }
 }

templates/shared_services/gitea/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-shared-service-gitea
-version: 1.2.1
+version: 1.2.2
 description: "A Gitea shared service"
 dockerfile: Dockerfile.tmpl
 registry: azuretre

templates/shared_services/gitea/template_schema.json

@@ -49,6 +49,9 @@
     }
   },
   "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    },
     "is_exposed_externally": {
       "classNames": "tre-hidden"
     }

templates/shared_services/sonatype-nexus-vm/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-shared-service-sonatype-nexus
-version: 3.3.5
+version: 3.3.6
 description: "A Sonatype Nexus shared service"
 dockerfile: Dockerfile.tmpl
 registry: azuretre

templates/shared_services/sonatype-nexus-vm/template_schema.json

@@ -57,6 +57,9 @@
     }
   },
   "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    },
     "is_exposed_externally": {
       "classNames": "tre-hidden"
     }

templates/workspace_services/azureml/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-service-azureml
-version: 1.1.2
+version: 1.1.3
 description: "An Azure TRE service for Azure Machine Learning"
 registry: azuretre
 dockerfile: Dockerfile.tmpl

templates/workspace_services/azureml/template_schema.json

@@ -59,6 +59,9 @@
     }
   },
   "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    },
     "address_space": {
       "classNames": "tre-hidden"
     },

templates/workspace_services/azureml/user_resources/aml_compute/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-user-resource-aml-compute-instance
-version: 0.5.12
+version: 0.5.13
 description: "Azure Machine Learning Compute Instance"
 registry: azuretre
 dockerfile: Dockerfile.tmpl

templates/workspace_services/azureml/user_resources/aml_compute/template_schema.json

@@ -46,5 +46,10 @@
       "default": "",
       "minLength": 1
     }
+  },
+  "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    }
   }
 }

templates/workspace_services/azuresql/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-workspace-service-azuresql
-version: 1.0.16
+version: 1.0.17
 description: "An Azure SQL workspace service"
 registry: azuretre
 dockerfile: Dockerfile.tmpl

templates/workspace_services/azuresql/template_schema.json

@@ -35,5 +35,10 @@
       "description": "Database name",
       "default": "tredb"
     }
+  },
+  "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    }
   }
 }

templates/workspace_services/databricks/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-service-databricks
-version: 1.0.14
+version: 1.0.15
 description: "An Azure TRE service for Azure Databricks."
 registry: azuretre
 dockerfile: Dockerfile.tmpl

templates/workspace_services/databricks/template_schema.json

@@ -42,6 +42,9 @@
     }
   },
   "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    },
     "address_space": {
       "classNames": "tre-hidden"
     }

templates/workspace_services/gitea/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-workspace-service-gitea
-version: 1.3.2
+version: 1.3.3
 description: "A Gitea workspace service"
 dockerfile: Dockerfile.tmpl
 registry: azuretre

templates/workspace_services/gitea/template_schema.json

@@ -50,6 +50,9 @@
     }
   },
   "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    },
     "is_exposed_externally": {
       "classNames": "tre-hidden"
     }

templates/workspace_services/guacamole/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-service-guacamole
-version: 0.14.1
+version: 0.14.2
 description: "An Azure TRE service for Guacamole"
 dockerfile: Dockerfile.tmpl
 registry: azuretre

templates/workspace_services/guacamole/template_schema.json

@@ -232,5 +232,8 @@
     ]
   },
   "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    }
   }
 }

templates/workspace_services/guacamole/user_resources/guacamole-azure-export-reviewvm/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-service-guacamole-export-reviewvm
-version: 0.3.5
+version: 0.3.6
 description: "An Azure TRE User Resource Template for reviewing Airlock export requests"
 dockerfile: Dockerfile.tmpl
 registry: azuretre

templates/workspace_services/guacamole/user_resources/guacamole-azure-export-reviewvm/template_schema.json

@@ -37,5 +37,10 @@
         "updateable": false,
         "sensitive": true
       }
+    },
+    "uiSchema": {
+      "overview": {
+        "ui:widget": "textarea"
+      }
     }
 }

templates/workspace_services/guacamole/user_resources/guacamole-azure-import-reviewvm/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-service-guacamole-import-reviewvm
-version: 0.4.4
+version: 0.4.5
 description: "An Azure TRE User Resource Template for reviewing Airlock import requests"
 dockerfile: Dockerfile.tmpl
 registry: azuretre

templates/workspace_services/guacamole/user_resources/guacamole-azure-import-reviewvm/template_schema.json

@@ -37,5 +37,10 @@
         "updateable": false,
         "sensitive": true
       }
+    },
+    "uiSchema": {
+      "overview": {
+        "ui:widget": "textarea"
+      }
     }
 }

templates/workspace_services/guacamole/user_resources/guacamole-azure-linuxvm/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-service-guacamole-linuxvm
-version: 1.4.3
+version: 1.4.4
 description: "An Azure TRE User Resource Template for Guacamole (Linux)"
 dockerfile: Dockerfile.tmpl
 registry: azuretre

templates/workspace_services/guacamole/user_resources/guacamole-azure-linuxvm/template_schema.json

@@ -249,6 +249,9 @@
     }
   ],
   "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    },
     "admin_username": {
       "classNames": "tre-hidden"
     }

templates/workspace_services/guacamole/user_resources/guacamole-azure-windowsvm/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-service-guacamole-windowsvm
-version: 1.4.4
+version: 1.4.5
 description: "An Azure TRE User Resource Template for Guacamole (Windows 10)"
 dockerfile: Dockerfile.tmpl
 registry: azuretre

templates/workspace_services/guacamole/user_resources/guacamole-azure-windowsvm/template_schema.json

@@ -248,6 +248,9 @@
     }
   ],
   "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    },
     "admin_username": {
       "classNames": "tre-hidden"
     }

templates/workspace_services/health-services/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-workspace-service-health
-version: 0.2.13
+version: 0.2.14
 description: "An Azure Data Health Services workspace service"
 registry: azuretre
 dockerfile: Dockerfile.tmpl

templates/workspace_services/health-services/template_schema.json

@@ -218,5 +218,10 @@
         "stepId": "main"
       }
     ]
+  },
+  "uiSchema": {
+    "overview": {
+      "ui:widget": "textarea"
+    }
   }
 }

templates/workspace_services/mysql/porter.yaml

@@ -1,7 +1,7 @@
 ---
 schemaVersion: 1.0.0
 name: tre-workspace-service-mysql
-version: 1.0.11
+version: 1.0.12
 description: "A MySQL workspace service"
 registry: azuretre
 dockerfile: Dockerfile.tmpl