aboutsummaryrefslogtreecommitdiffstats
path: root/catalog-be/src/main/resources/import/tosca/models/upgrade/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'catalog-be/src/main/resources/import/tosca/models/upgrade/README.md')
-rw-r--r--catalog-be/src/main/resources/import/tosca/models/upgrade/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/catalog-be/src/main/resources/import/tosca/models/upgrade/README.md b/catalog-be/src/main/resources/import/tosca/models/upgrade/README.md
new file mode 100644
index 0000000000..ff4bef204c
--- /dev/null
+++ b/catalog-be/src/main/resources/import/tosca/models/upgrade/README.md
@@ -0,0 +1,26 @@
+This folder purpose is to contain any models that needs its imports file updated during the
+initialization of an upgrade.
+
+```bash
+├── upgrade
+│ ├── <model_1_to_upgrade>
+│ │ ├── payload.json
+│ │ ├── imports
+│ │ │ ├── **/*.yaml
+[...]
+│ ├── <model_n_to_upgrade>
+│ │ ├── payload.json
+│ │ ├── imports
+│ │ │ ├── **/*.yaml
+```
+
+The model folder name is irrelevant to indicate which model should be updated. This information must
+be provided in the payload.json contained within the model folder.
+
+The content of the payload.json for the model with name "ETSI SOL001 v2.5.1" is expected to be:
+```json
+{
+ "name": "ETSI SOL001 v2.5.1"
+}
+```
+