Automated commit by github action: 3912805923

idn/beta/paths/sp-config-import.yaml

@@ -7,6 +7,11 @@ post:
   summary: Initiates Configuration Objects Import Job.
   description: >-
     This post will import objects from a JSON configuration file into a tenant.
+    By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted.
+    The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed.
+    The backup can be skipped by setting "excludeBackup" to true in the import options.
+    If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded 
+    using the /sp-config/export/{exportJobId}/download endpoint.
 
     Request will need the following security scope:
 
@@ -48,7 +53,8 @@ post:
                 "id": "be9e116d-08e1-49fc-ab7f-fa585e96c9e4",
                 "name": "Test Trigger"
               }
-            ]
+            ],
+            "excludeBackup": false
           }
 
       __Sample Import File__
@@ -120,7 +126,8 @@ post:
                 "id": "be9e116d-08e1-49fc-ab7f-fa585e96c9e4",
                 "name": "Test Trigger"
               }
-            ]
+            ],
+            "excludeBackup": false
           }
         }
   responses:

idn/beta/schemas/ImportOptions.yaml

@@ -28,3 +28,8 @@ properties:
     type: array
     items:
       $ref: '../../v3/schemas/BaseReferenceDto.yaml'
+  excludeBackup:
+    description: By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed.
+    type: boolean
+    default: false
+    example: "false"

idn/beta/schemas/SpConfigImportResults.yaml

@@ -28,5 +28,9 @@ properties:
             }
           }
         }
+  exportJobId:
+    type: string
+    description: If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export.
+    example: "be9e116d-08e1-49fc-ab7f-fa585e96c9e4"
 required:
   - results