Skip to content

Commit 5ff420b

Browse files
MrHinshMrHinsh
committed
Update processor configurations to mark essential parameters as required
- Changed `isRequired` property to `true` for multiple parameters across various processor YAML files, ensuring that critical options must be provided for successful execution. - Updated schema definitions to include required fields for several processors, enhancing validation and preventing misconfigurations. - Modified `ClassDataLoader` to dynamically determine required properties using DataAnnotations, improving the robustness of the configuration loading process.
1 parent fd3d770 commit 5ff420b

File tree

50 files changed

+396
-131
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+396
-131
lines changed

‎docs/data/classes/reference.endpoints.azuredevopsendpoint.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ options:
4747
type: String
4848
description: Personal Access Token (PAT) or other authentication token for accessing the Azure DevOps organization. Required for API authentication.
4949
defaultValue: missing XML code comments
50-
isRequired: false
50+
isRequired: true
5151
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
5252
- parameterName: AuthenticationMode
5353
type: AuthenticationMode
5454
description: Authentication mode to use when connecting to Azure DevOps. Typically uses AccessToken for modern Azure DevOps organizations.
5555
defaultValue: missing XML code comments
56-
isRequired: false
56+
isRequired: true
5757
dotNetType: MigrationTools.Endpoints.AuthenticationMode, MigrationTools, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
5858
- parameterName: Enabled
5959
type: Boolean
@@ -77,19 +77,19 @@ options:
7777
type: String
7878
description: URL of the Azure DevOps organization (e.g., "https://dev.azure.com/myorganization/"). Must include the full organization URL.
7979
defaultValue: missing XML code comments
80-
isRequired: false
80+
isRequired: true
8181
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8282
- parameterName: Project
8383
type: String
8484
description: Name of the Azure DevOps project within the organization to connect to. This is the project that will be used for migration operations.
8585
defaultValue: missing XML code comments
86-
isRequired: false
86+
isRequired: true
8787
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8888
- parameterName: ReflectedWorkItemIdField
8989
type: String
9090
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
9191
defaultValue: missing XML code comments
92-
isRequired: false
92+
isRequired: true
9393
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
9494
status: missing XML code comments
9595
processingTarget: missing XML code comments

‎docs/data/classes/reference.endpoints.tfsendpoint.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,13 @@ options:
104104
type: TfsAuthenticationOptions
105105
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
106106
defaultValue: missing XML code comments
107-
isRequired: false
107+
isRequired: true
108108
dotNetType: MigrationTools.Endpoints.Infrastructure.TfsAuthenticationOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
109109
- parameterName: Collection
110110
type: Uri
111111
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
112112
defaultValue: missing XML code comments
113-
isRequired: false
113+
isRequired: true
114114
dotNetType: System.Uri, System.Private.Uri, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
115115
- parameterName: Enabled
116116
type: Boolean
@@ -128,7 +128,7 @@ options:
128128
type: TfsLanguageMapOptions
129129
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
130130
defaultValue: missing XML code comments
131-
isRequired: false
131+
isRequired: true
132132
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
133133
- parameterName: Name
134134
type: String
@@ -140,13 +140,13 @@ options:
140140
type: String
141141
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
142142
defaultValue: missing XML code comments
143-
isRequired: false
143+
isRequired: true
144144
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
145145
- parameterName: ReflectedWorkItemIdField
146146
type: String
147147
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
148148
defaultValue: missing XML code comments
149-
isRequired: false
149+
isRequired: true
150150
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
151151
status: missing XML code comments
152152
processingTarget: missing XML code comments

‎docs/data/classes/reference.endpoints.tfsteamprojectendpoint.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,13 @@ options:
100100
type: TfsAuthenticationOptions
101101
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
102102
defaultValue: missing XML code comments
103-
isRequired: false
103+
isRequired: true
104104
dotNetType: MigrationTools.Endpoints.Infrastructure.TfsAuthenticationOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
105105
- parameterName: Collection
106106
type: Uri
107107
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
108108
defaultValue: missing XML code comments
109-
isRequired: false
109+
isRequired: true
110110
dotNetType: System.Uri, System.Private.Uri, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
111111
- parameterName: Enabled
112112
type: Boolean
@@ -124,7 +124,7 @@ options:
124124
type: TfsLanguageMapOptions
125125
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
126126
defaultValue: missing XML code comments
127-
isRequired: false
127+
isRequired: true
128128
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
129129
- parameterName: Name
130130
type: String
@@ -136,13 +136,13 @@ options:
136136
type: String
137137
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
138138
defaultValue: missing XML code comments
139-
isRequired: false
139+
isRequired: true
140140
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
141141
- parameterName: ReflectedWorkItemIdField
142142
type: String
143143
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
144144
defaultValue: missing XML code comments
145-
isRequired: false
145+
isRequired: true
146146
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
147147
status: missing XML code comments
148148
processingTarget: missing XML code comments

‎docs/data/classes/reference.endpoints.tfsteamsettingsendpoint.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ options:
4141
type: TfsAuthenticationOptions
4242
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
4343
defaultValue: missing XML code comments
44-
isRequired: false
44+
isRequired: true
4545
dotNetType: MigrationTools.Endpoints.Infrastructure.TfsAuthenticationOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
4646
- parameterName: Collection
4747
type: Uri
4848
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
4949
defaultValue: missing XML code comments
50-
isRequired: false
50+
isRequired: true
5151
dotNetType: System.Uri, System.Private.Uri, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
5252
- parameterName: Enabled
5353
type: Boolean
@@ -65,7 +65,7 @@ options:
6565
type: TfsLanguageMapOptions
6666
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
6767
defaultValue: missing XML code comments
68-
isRequired: false
68+
isRequired: true
6969
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
7070
- parameterName: Name
7171
type: String
@@ -77,13 +77,13 @@ options:
7777
type: String
7878
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
7979
defaultValue: missing XML code comments
80-
isRequired: false
80+
isRequired: true
8181
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8282
- parameterName: ReflectedWorkItemIdField
8383
type: String
8484
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
8585
defaultValue: missing XML code comments
86-
isRequired: false
86+
isRequired: true
8787
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8888
status: missing XML code comments
8989
processingTarget: missing XML code comments

‎docs/data/classes/reference.endpoints.tfsworkitemendpoint.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ options:
4242
type: TfsAuthenticationOptions
4343
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
4444
defaultValue: missing XML code comments
45-
isRequired: false
45+
isRequired: true
4646
dotNetType: MigrationTools.Endpoints.Infrastructure.TfsAuthenticationOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
4747
- parameterName: Collection
4848
type: Uri
4949
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
5050
defaultValue: missing XML code comments
51-
isRequired: false
51+
isRequired: true
5252
dotNetType: System.Uri, System.Private.Uri, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
5353
- parameterName: Enabled
5454
type: Boolean
@@ -66,7 +66,7 @@ options:
6666
type: TfsLanguageMapOptions
6767
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
6868
defaultValue: missing XML code comments
69-
isRequired: false
69+
isRequired: true
7070
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
7171
- parameterName: Name
7272
type: String
@@ -78,7 +78,7 @@ options:
7878
type: String
7979
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
8080
defaultValue: missing XML code comments
81-
isRequired: false
81+
isRequired: true
8282
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8383
- parameterName: Query
8484
type: QueryOptions
@@ -90,7 +90,7 @@ options:
9090
type: String
9191
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
9292
defaultValue: missing XML code comments
93-
isRequired: false
93+
isRequired: true
9494
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
9595
status: missing XML code comments
9696
processingTarget: missing XML code comments

‎docs/data/classes/reference.processors.azuredevopspipelineprocessor.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ options:
8484
type: Boolean
8585
description: If set to `true` then the processor will run. Set to `false` and the processor will not run.
8686
defaultValue: missing XML code comments
87-
isRequired: false
87+
isRequired: true
8888
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8989
- parameterName: Enrichers
9090
type: List
@@ -144,13 +144,13 @@ options:
144144
type: String
145145
description: This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.
146146
defaultValue: missing XML code comments
147-
isRequired: false
147+
isRequired: true
148148
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
149149
- parameterName: TargetName
150150
type: String
151151
description: This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.
152152
defaultValue: missing XML code comments
153-
isRequired: false
153+
isRequired: true
154154
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
155155
status: Beta
156156
processingTarget: Pipelines

‎docs/data/classes/reference.processors.keepoutboundlinktargetprocessor.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ options:
4848
type: Boolean
4949
description: If set to `true` then the processor will run. Set to `false` and the processor will not run.
5050
defaultValue: missing XML code comments
51-
isRequired: false
51+
isRequired: true
5252
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
5353
- parameterName: Enrichers
5454
type: List
@@ -72,7 +72,7 @@ options:
7272
type: String
7373
description: This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.
7474
defaultValue: missing XML code comments
75-
isRequired: false
75+
isRequired: true
7676
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
7777
- parameterName: TargetLinksToKeepOrganization
7878
type: String
@@ -90,13 +90,13 @@ options:
9090
type: String
9191
description: This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.
9292
defaultValue: missing XML code comments
93-
isRequired: false
93+
isRequired: true
9494
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
9595
- parameterName: WIQLQuery
9696
type: String
9797
description: WIQL (Work Item Query Language) query used to select the work items whose outbound links should be processed for preservation.
9898
defaultValue: missing XML code comments
99-
isRequired: false
99+
isRequired: true
100100
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
101101
status: missing XML code comments
102102
processingTarget: missing XML code comments

‎docs/data/classes/reference.processors.outboundlinkcheckingprocessor.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ options:
3232
type: Boolean
3333
description: If set to `true` then the processor will run. Set to `false` and the processor will not run.
3434
defaultValue: missing XML code comments
35-
isRequired: false
35+
isRequired: true
3636
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
3737
- parameterName: Enrichers
3838
type: List
@@ -50,25 +50,25 @@ options:
5050
type: String
5151
description: File name where the results of the outbound link checking process will be saved, typically containing details of broken or invalid links.
5252
defaultValue: missing XML code comments
53-
isRequired: false
53+
isRequired: true
5454
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
5555
- parameterName: SourceName
5656
type: String
5757
description: This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.
5858
defaultValue: missing XML code comments
59-
isRequired: false
59+
isRequired: true
6060
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
6161
- parameterName: TargetName
6262
type: String
6363
description: This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.
6464
defaultValue: missing XML code comments
65-
isRequired: false
65+
isRequired: true
6666
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
6767
- parameterName: WIQLQuery
6868
type: String
6969
description: WIQL (Work Item Query Language) query used to select the work items whose outbound links should be checked for validity.
7070
defaultValue: missing XML code comments
71-
isRequired: false
71+
isRequired: true
7272
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
7373
status: missing XML code comments
7474
processingTarget: missing XML code comments

‎docs/data/classes/reference.processors.processdefinitionprocessor.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ options:
3434
type: Boolean
3535
description: If set to `true` then the processor will run. Set to `false` and the processor will not run.
3636
defaultValue: missing XML code comments
37-
isRequired: false
37+
isRequired: true
3838
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
3939
- parameterName: Enrichers
4040
type: List
@@ -70,13 +70,13 @@ options:
7070
type: String
7171
description: This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.
7272
defaultValue: missing XML code comments
73-
isRequired: false
73+
isRequired: true
7474
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
7575
- parameterName: TargetName
7676
type: String
7777
description: This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.
7878
defaultValue: missing XML code comments
79-
isRequired: false
79+
isRequired: true
8080
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8181
- parameterName: UpdateProcessDetails
8282
type: Boolean

‎docs/data/classes/reference.processors.tfsexportprofilepicturefromadprocessor.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ options:
4040
type: Boolean
4141
description: If set to `true` then the processor will run. Set to `false` and the processor will not run.
4242
defaultValue: missing XML code comments
43-
isRequired: false
43+
isRequired: true
4444
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
4545
- parameterName: Enrichers
4646
type: List
@@ -70,13 +70,13 @@ options:
7070
type: String
7171
description: This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.
7272
defaultValue: missing XML code comments
73-
isRequired: false
73+
isRequired: true
7474
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
7575
- parameterName: TargetName
7676
type: String
7777
description: This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.
7878
defaultValue: missing XML code comments
79-
isRequired: false
79+
isRequired: true
8080
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8181
- parameterName: Username
8282
type: String

0 commit comments

Comments
 (0)