Update generated docs

nkdAgility · Sep 24, 2024 · 57129e6 · 57129e6
1 parent 48d5f5c
commit 57129e6
Show file tree

Hide file tree

Showing 50 changed files with 105 additions and 633 deletions.
diff --git a/docs/Reference/Generated/MigrationTools.Clients.TfsObjectModel.xml b/docs/Reference/Generated/MigrationTools.Clients.TfsObjectModel.xml
diff --git a/docs/Reference/Generated/MigrationTools.xml b/docs/Reference/Generated/MigrationTools.xml
diff --git a/docs/_data/reference.endpoints.azuredevopsendpoint.yaml b/docs/_data/reference.endpoints.azuredevopsendpoint.yaml
@@ -17,7 +17,8 @@ configurationSamples:
             "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
             "AuthenticationMode": "AccessToken",
             "Organisation": "https://dev.azure.com/xxx/",
-            "Project": "myProject"
+            "Project": "myProject",
+            "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
           }
         }
       }
@@ -32,8 +33,7 @@ configurationSamples:
       "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
       "Organisation": "https://dev.azure.com/xxx/",
       "Project": "myProject",
-      "ReflectedWorkItemIdField": null,
-      "EndpointEnrichers": null
+      "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
     }
   sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
 description: missing XML code comments
@@ -49,10 +49,6 @@ options:
   type: AuthenticationMode
   description: missing XML code comments
   defaultValue: missing XML code comments
-- parameterName: EndpointEnrichers
-  type: List
-  description: missing XML code comments
-  defaultValue: missing XML code comments
 - parameterName: Organisation
   type: String
   description: missing XML code comments

diff --git a/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml b/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml
@@ -14,19 +14,14 @@ configurationSamples:
   code: >-
     {
       "$type": "FileSystemWorkItemEndpointOptions",
-      "FileStore": null,
-      "EndpointEnrichers": null
+      "FileStore": null
     }
   sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
 description: missing XML code comments
 className: FileSystemWorkItemEndpoint
 typeName: Endpoints
 architecture: 
 options:
-- parameterName: EndpointEnrichers
-  type: List
-  description: missing XML code comments
-  defaultValue: missing XML code comments
 - parameterName: FileStore
   type: String
   description: missing XML code comments

diff --git a/docs/_data/reference.endpoints.tfsendpoint.yaml b/docs/_data/reference.endpoints.tfsendpoint.yaml
@@ -26,7 +26,8 @@ configurationSamples:
               "AreaPath": "Area",
               "IterationPath": "Iteration"
             },
-            "Project": ""
+            "Project": "",
+            "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
           }
         }
       }
@@ -56,7 +57,8 @@ configurationSamples:
               "AreaPath": "Area",
               "IterationPath": "Iteration"
             },
-            "Project": "migrationSource1"
+            "Project": "migrationSource1",
+            "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
           }
         }
       }
@@ -78,24 +80,18 @@ configurationSamples:
         },
         "AccessToken": "** removed as a secret ***"
       },
-      "ReflectedWorkItemIdField": null,
-      "AllowCrossProjectLinking": false,
+      "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
       "LanguageMaps": {
         "AreaPath": "Area",
         "IterationPath": "Iteration"
-      },
-      "EndpointEnrichers": null
+      }
     }
   sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
 description: missing XML code comments
 className: TfsEndpoint
 typeName: Endpoints
 architecture: 
 options:
-- parameterName: AllowCrossProjectLinking
-  type: Boolean
-  description: missing XML code comments
-  defaultValue: missing XML code comments
 - parameterName: Authentication
   type: TfsAuthenticationOptions
   description: missing XML code comments
@@ -104,10 +100,6 @@ options:
   type: Uri
   description: missing XML code comments
   defaultValue: missing XML code comments
-- parameterName: EndpointEnrichers
-  type: List
-  description: missing XML code comments
-  defaultValue: missing XML code comments
 - parameterName: LanguageMaps
   type: TfsLanguageMapOptions
   description: missing XML code comments

diff --git a/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml b/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml
@@ -26,7 +26,8 @@ configurationSamples:
               "AreaPath": "Area",
               "IterationPath": "Iteration"
             },
-            "Project": ""
+            "Project": "",
+            "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
           }
         }
       }
@@ -52,11 +53,8 @@ configurationSamples:
               }
             },
             "Collection": "https://dev.azure.com/nkdagility-preview/",
-            "LanguageMaps": {
-              "AreaPath": "Area",
-              "IterationPath": "Iteration"
-            },
-            "Project": "migrationSource1"
+            "Project": "migrationSource1",
+            "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
           }
         }
       }
@@ -78,24 +76,18 @@ configurationSamples:
         },
         "AccessToken": "** removed as a secret ***"
       },
-      "ReflectedWorkItemIdField": null,
-      "AllowCrossProjectLinking": false,
+      "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
       "LanguageMaps": {
         "AreaPath": "Area",
         "IterationPath": "Iteration"
-      },
-      "EndpointEnrichers": null
+      }
     }
   sampleFor: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions
 description: missing XML code comments
 className: TfsTeamProjectEndpoint
 typeName: Endpoints
 architecture: 
 options:
-- parameterName: AllowCrossProjectLinking
-  type: Boolean
-  description: missing XML code comments
-  defaultValue: missing XML code comments
 - parameterName: Authentication
   type: TfsAuthenticationOptions
   description: missing XML code comments
@@ -104,10 +96,6 @@ options:
   type: Uri
   description: missing XML code comments
   defaultValue: missing XML code comments
-- parameterName: EndpointEnrichers
-  type: List
-  description: missing XML code comments
-  defaultValue: missing XML code comments
 - parameterName: LanguageMaps
   type: TfsLanguageMapOptions
   description: missing XML code comments

diff --git a/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml b/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml
@@ -18,20 +18,17 @@ configurationSamples:
       "Project": null,
       "Authentication": null,
       "ReflectedWorkItemIdField": null,
-      "AllowCrossProjectLinking": false,
-      "LanguageMaps": null,
-      "EndpointEnrichers": null
+      "LanguageMaps": {
+        "AreaPath": "Area",
+        "IterationPath": "Iteration"
+      }
     }
   sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
 description: missing XML code comments
 className: TfsTeamSettingsEndpoint
 typeName: Endpoints
 architecture: 
 options:
-- parameterName: AllowCrossProjectLinking
-  type: Boolean
-  description: missing XML code comments
-  defaultValue: missing XML code comments
 - parameterName: Authentication
   type: TfsAuthenticationOptions
   description: missing XML code comments
@@ -40,10 +37,6 @@ options:
   type: Uri
   description: missing XML code comments
   defaultValue: missing XML code comments
-- parameterName: EndpointEnrichers
-  type: List
-  description: missing XML code comments
-  defaultValue: missing XML code comments
 - parameterName: LanguageMaps
   type: TfsLanguageMapOptions
   description: missing XML code comments

diff --git a/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml b/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml
@@ -19,20 +19,17 @@ configurationSamples:
       "Query": null,
       "Authentication": null,
       "ReflectedWorkItemIdField": null,
-      "AllowCrossProjectLinking": false,
-      "LanguageMaps": null,
-      "EndpointEnrichers": null
+      "LanguageMaps": {
+        "AreaPath": "Area",
+        "IterationPath": "Iteration"
+      }
     }
   sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
 description: missing XML code comments
 className: TfsWorkItemEndpoint
 typeName: Endpoints
 architecture: 
 options:
-- parameterName: AllowCrossProjectLinking
-  type: Boolean
-  description: missing XML code comments
-  defaultValue: missing XML code comments
 - parameterName: Authentication
   type: TfsAuthenticationOptions
   description: missing XML code comments
@@ -41,10 +38,6 @@ options:
   type: Uri
   description: missing XML code comments
   defaultValue: missing XML code comments
-- parameterName: EndpointEnrichers
-  type: List
-  description: missing XML code comments
-  defaultValue: missing XML code comments
 - parameterName: LanguageMaps
   type: TfsLanguageMapOptions
   description: missing XML code comments

diff --git a/docs/_data/reference.processors.azuredevopspipelineprocessor.yaml b/docs/_data/reference.processors.azuredevopspipelineprocessor.yaml
@@ -63,10 +63,8 @@ configurationSamples:
       "BuildPipelines": null,
       "ReleasePipelines": null,
       "RepositoryNameMaps": null,
-      "Enrichers": null,
       "SourceName": "sourceName",
-      "TargetName": "targetName",
-      "RefName": null
+      "TargetName": "targetName"
     }
   sampleFor: MigrationTools.Processors.AzureDevOpsPipelineProcessorOptions
 description: Azure DevOps Processor that migrates Taskgroups, Build- and Release Pipelines.
@@ -82,10 +80,6 @@ options:
   type: Boolean
   description: If set to `true` then the processor will run. Set to `false` and the processor will not run.
   defaultValue: missing XML code comments
-- parameterName: Enrichers
-  type: List
-  description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors.
-  defaultValue: missing XML code comments
 - parameterName: MigrateBuildPipelines
   type: Boolean
   description: Migrate Build Pipelines
@@ -106,10 +100,6 @@ options:
   type: Boolean
   description: Migrate Valiable Groups
   defaultValue: true
-- parameterName: RefName
-  type: String
-  description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.'
-  defaultValue: missing XML code comments
 - parameterName: ReleasePipelines
   type: List
   description: List of Release Pipelines to process. If this is `null` then all Release Pipelines will be processed.