Update docs

nkdAgility · Aug 19, 2024 · f6373c3 · f6373c3
1 parent 87f1e08
commit f6373c3
Show file tree

Hide file tree

Showing 20 changed files with 610 additions and 67 deletions.
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
@@ -1,11 +1,64 @@
 optionsClassName: AzureDevOpsEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
-configurationSamples: []
+configurationSamples:
+- name: defaults
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "EndpointDefaults": {
+          "AzureDevOpsEndpoint": {}
+        }
+      }
+    }
+  sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
+- name: Classic
+  description: 
+  code: >-
+    {
+      "$type": "AzureDevOpsEndpointOptions",
+      "AuthenticationMode": 0,
+      "AccessToken": null,
+      "Organisation": null,
+      "Project": null,
+      "ReflectedWorkItemIdField": null,
+      "Name": null,
+      "EndpointEnrichers": null
+    }
+  sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
 description: missng XML code comments
 className: AzureDevOpsEndpoint
 typeName: Endpoints
-architecture: v2
-options: []
+architecture: 
+options:
+- parameterName: AccessToken
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: AuthenticationMode
+  type: AuthenticationMode
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: EndpointEnrichers
+  type: List
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Name
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Organisation
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Project
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: ReflectedWorkItemIdField
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
 status: missng XML code comments
 processingTarget: missng XML code comments
 classFile: /src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpoint.cs

diff --git a/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml b/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml
@@ -1,11 +1,44 @@
 optionsClassName: FileSystemWorkItemEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
-configurationSamples: []
+configurationSamples:
+- name: defaults
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "EndpointDefaults": {
+          "FileSystemWorkItemEndpoint": {}
+        }
+      }
+    }
+  sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
+- name: Classic
+  description: 
+  code: >-
+    {
+      "$type": "FileSystemWorkItemEndpointOptions",
+      "FileStore": null,
+      "Name": null,
+      "EndpointEnrichers": null
+    }
+  sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
 description: missng XML code comments
 className: FileSystemWorkItemEndpoint
 typeName: Endpoints
-architecture: v2
-options: []
+architecture: 
+options:
+- parameterName: EndpointEnrichers
+  type: List
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: FileStore
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Name
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
 status: missng XML code comments
 processingTarget: missng XML code comments
 classFile: /src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpoint.cs

diff --git a/docs/_data/reference.endpoints.tfsendpoint.yaml b/docs/_data/reference.endpoints.tfsendpoint.yaml
@@ -1,11 +1,69 @@
 optionsClassName: TfsEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.TfsEndpointOptions
-configurationSamples: []
+configurationSamples:
+- name: defaults
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "EndpointDefaults": {
+          "TfsEndpoint": {}
+        }
+      }
+    }
+  sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
+- name: Classic
+  description: 
+  code: >-
+    {
+      "$type": "TfsEndpointOptions",
+      "Organisation": null,
+      "Project": null,
+      "AuthenticationMode": "AccessToken",
+      "AccessToken": null,
+      "ReflectedWorkItemIdField": null,
+      "LanguageMaps": null,
+      "Name": null,
+      "EndpointEnrichers": null
+    }
+  sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
 description: missng XML code comments
 className: TfsEndpoint
 typeName: Endpoints
-architecture: v2
-options: []
+architecture: 
+options:
+- parameterName: AccessToken
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: AuthenticationMode
+  type: AuthenticationMode
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: EndpointEnrichers
+  type: List
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: LanguageMaps
+  type: TfsLanguageMapOptions
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Name
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Organisation
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Project
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: ReflectedWorkItemIdField
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
 status: missng XML code comments
 processingTarget: missng XML code comments
 classFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/Endpoints/TfsEndpoint.cs

diff --git a/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml b/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml
@@ -1,11 +1,69 @@
 optionsClassName: TfsTeamSettingsEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
-configurationSamples: []
+configurationSamples:
+- name: defaults
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "EndpointDefaults": {
+          "TfsTeamSettingsEndpoint": {}
+        }
+      }
+    }
+  sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
+- name: Classic
+  description: 
+  code: >-
+    {
+      "$type": "TfsTeamSettingsEndpointOptions",
+      "Organisation": null,
+      "Project": null,
+      "AuthenticationMode": "AccessToken",
+      "AccessToken": null,
+      "ReflectedWorkItemIdField": null,
+      "LanguageMaps": null,
+      "Name": null,
+      "EndpointEnrichers": null
+    }
+  sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
 description: missng XML code comments
 className: TfsTeamSettingsEndpoint
 typeName: Endpoints
-architecture: v2
-options: []
+architecture: 
+options:
+- parameterName: AccessToken
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: AuthenticationMode
+  type: AuthenticationMode
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: EndpointEnrichers
+  type: List
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: LanguageMaps
+  type: TfsLanguageMapOptions
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Name
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Organisation
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Project
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: ReflectedWorkItemIdField
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
 status: missng XML code comments
 processingTarget: missng XML code comments
 classFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/Endpoints/TfsTeamSettingsEndpoint.cs

diff --git a/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml b/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml
@@ -1,11 +1,74 @@
 optionsClassName: TfsWorkItemEndpointOptions
 optionsClassFullName: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
-configurationSamples: []
+configurationSamples:
+- name: defaults
+  description: 
+  code: >-
+    {
+      "MigrationTools": {
+        "EndpointDefaults": {
+          "TfsWorkItemEndpoint": {}
+        }
+      }
+    }
+  sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
+- name: Classic
+  description: 
+  code: >-
+    {
+      "$type": "TfsWorkItemEndpointOptions",
+      "Organisation": null,
+      "Project": null,
+      "Query": null,
+      "AuthenticationMode": "AccessToken",
+      "AccessToken": null,
+      "ReflectedWorkItemIdField": null,
+      "LanguageMaps": null,
+      "Name": null,
+      "EndpointEnrichers": null
+    }
+  sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
 description: missng XML code comments
 className: TfsWorkItemEndpoint
 typeName: Endpoints
-architecture: v2
-options: []
+architecture: 
+options:
+- parameterName: AccessToken
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: AuthenticationMode
+  type: AuthenticationMode
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: EndpointEnrichers
+  type: List
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: LanguageMaps
+  type: TfsLanguageMapOptions
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Name
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Organisation
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Project
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: Query
+  type: QueryOptions
+  description: missng XML code comments
+  defaultValue: missng XML code comments
+- parameterName: ReflectedWorkItemIdField
+  type: String
+  description: missng XML code comments
+  defaultValue: missng XML code comments
 status: missng XML code comments
 processingTarget: missng XML code comments
 classFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/Endpoints/TfsWorkItemEndpoint.cs

diff --git a/docs/_data/reference.processorenrichers.pauseaftereachitem.yaml b/docs/_data/reference.processorenrichers.pauseaftereachitem.yaml
@@ -23,7 +23,7 @@ configurationSamples:
 description: missng XML code comments
 className: PauseAfterEachItem
 typeName: ProcessorEnrichers
-architecture: v2
+architecture: 
 options:
 - parameterName: Enabled
   type: Boolean

diff --git a/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml b/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml
@@ -20,7 +20,7 @@ configurationSamples:
       "Enabled": false,
       "WIQLQuery": "Select [System.Id] From WorkItems Where [System.TeamProject] = @project and not [System.WorkItemType] contains 'Test Suite, Test Plan,Shared Steps,Shared Parameter,Feedback Request'",
       "TargetLinksToKeepOrganization": "https://dev.azure.com/nkdagility",
-      "TargetLinksToKeepProject": "cb162c4a-add1-45f5-b200-699ccd72fd57",
+      "TargetLinksToKeepProject": "18dd319a-ea75-4ffc-b503-5479a3712777",
       "CleanupFileName": "c:/temp/OutboundLinkTargets.bat",
       "PrependCommand": "start",
       "DryRun": true,