Regenerate docs

Author: satano

docs/data/classes/reference.tools.exportworkitemmappingtool.yaml

@@ -0,0 +1,55 @@
+optionsClassName: ExportWorkItemMappingToolOptions
+optionsClassFullName: MigrationTools.Tools.ExportWorkItemMappingToolOptions
+configurationSamples:
+- name: defaults
+  order: 2
+  description: 
+  code: There are no defaults! Check the sample for options!
+  sampleFor: MigrationTools.Tools.ExportWorkItemMappingToolOptions
+- name: sample
+  order: 1
+  description: 
+  code: There is no sample, but you can check the classic below for a general feel.
+  sampleFor: MigrationTools.Tools.ExportWorkItemMappingToolOptions
+- name: classic
+  order: 3
+  description: 
+  code: >-
+    {
+      "$type": "ExportWorkItemMappingToolOptions",
+      "Enabled": false,
+      "TargetFile": "",
+      "PreserveExisting": true
+    }
+  sampleFor: MigrationTools.Tools.ExportWorkItemMappingToolOptions
+description: >-
+  Tool for exporting mappings of work item IDs from source to target.
+   Work item migration processor uses this tool to record work item ID mappings.
+   The mappings will be saved to file defined in options at the end of the migration.
+className: ExportWorkItemMappingTool
+typeName: Tools
+options:
+- parameterName: Enabled
+  type: Boolean
+  description: If set to `true` then the tool will run. Set to `false` and the processor will not run.
+  defaultValue: true
+  isRequired: false
+  dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
+- parameterName: PreserveExisting
+  type: Boolean
+  description: >-
+    Indicates whether existing mappings in the target file should be preserved when saving new mappings.
+     Default value is `true`.
+  defaultValue: true
+  isRequired: false
+  dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
+- parameterName: TargetFile
+  type: String
+  description: Path to file, where work item mapping will be saved.
+  defaultValue: String.Empty
+  isRequired: false
+  dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
+status: missing XML code comments
+processingTarget: missing XML code comments
+classFile: src/MigrationTools/Tools/ExportWorkItemMappingTool.cs
+optionsClassFile: src/MigrationTools/Tools/ExportWorkItemMappingToolOptions.cs

docs/static/schema/configuration.schema.json

@@ -1731,6 +1731,28 @@
         "CommonTools": {
           "type": "object",
           "properties": {
+            "ExportWorkItemMappingTool": {
+              "title": "ExportWorkItemMappingTool",
+              "description": "Tool for exporting mappings of work item IDs from source to target.\r\n Work item migration processor uses this tool to record work item ID mappings.\r\n The mappings will be saved to file defined in options at the end of the migration.",
+              "type": "object",
+              "properties": {
+                "Enabled": {
+                  "description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
+                  "type": "boolean",
+                  "default": "true"
+                },
+                "PreserveExisting": {
+                  "description": "Indicates whether existing mappings in the target file should be preserved when saving new mappings.\r\n Default value is `true`.",
+                  "type": "boolean",
+                  "default": "true"
+                },
+                "TargetFile": {
+                  "description": "Path to file, where work item mapping will be saved.",
+                  "type": "string",
+                  "default": "String.Empty"
+                }
+              }
+            },
             "FieldMappingTool": {
               "title": "FieldMappingTool",
               "description": "Tool for applying field mapping transformations to work items during migration, supporting various field mapping strategies like direct mapping, regex transformations, and value lookups.",

docs/static/schema/schema.tools.exportworkitemmappingtool.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://devopsmigration.io/schema/schema.tools.exportworkitemmappingtool.json",
+  "title": "ExportWorkItemMappingTool",
+  "description": "Tool for exporting mappings of work item IDs from source to target.\r\n Work item migration processor uses this tool to record work item ID mappings.\r\n The mappings will be saved to file defined in options at the end of the migration.",
+  "type": "object",
+  "properties": {
+    "Enabled": {
+      "description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
+      "type": "boolean",
+      "default": "true"
+    },
+    "PreserveExisting": {
+      "description": "Indicates whether existing mappings in the target file should be preserved when saving new mappings.\r\n Default value is `true`.",
+      "type": "boolean",
+      "default": "true"
+    },
+    "TargetFile": {
+      "description": "Path to file, where work item mapping will be saved.",
+      "type": "string",
+      "default": "String.Empty"
+    }
+  }
+}

src/MigrationTools/Tools/ExportWorkItemMappingToolOptions.cs

@@ -15,11 +15,13 @@ public ExportWorkItemMappingToolOptions()
     /// <summary>
     /// Path to file, where work item mapping will be saved.
     /// </summary>
-    public string TargetFile { get; set; }
+    /// <default>String.Empty</default>
+    public string TargetFile { get; set; } = string.Empty;
 
     /// <summary>
     /// Indicates whether existing mappings in the target file should be preserved when saving new mappings.
     /// Default value is <see langword="true"/>.
     /// </summary>
+    /// <default>true</default>
     public bool PreserveExisting { get; set; } = true;
 }