Skip to content

Commit 44e5a01

Browse files
MrHinshMrHinsh
committed
Add ProductVersion parameter to TFS endpoint configurations and update required fields
1 parent 1f80f4c commit 44e5a01

9 files changed

+78
-34
lines changed

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

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ configurationSamples:
8787
"LanguageMaps": {
8888
"AreaPath": "Area",
8989
"IterationPath": "Iteration"
90-
}
90+
},
91+
"ProductVersion": "OnPremises"
9192
}
9293
sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
9394
description: missing XML code comments
@@ -128,14 +129,20 @@ options:
128129
type: TfsLanguageMapOptions
129130
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
130131
defaultValue: missing XML code comments
131-
isRequired: true
132+
isRequired: false
132133
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
133134
- parameterName: Name
134135
type: String
135136
description: missing XML code comments
136137
defaultValue: missing XML code comments
137138
isRequired: false
138139
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
140+
- parameterName: ProductVersion
141+
type: TfsProductVersion
142+
description: Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.
143+
defaultValue: missing XML code comments
144+
isRequired: false
145+
dotNetType: MigrationTools.Endpoints.TfsProductVersion, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
139146
- parameterName: Project
140147
type: String
141148
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
@@ -146,7 +153,7 @@ options:
146153
type: String
147154
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
148155
defaultValue: missing XML code comments
149-
isRequired: true
156+
isRequired: false
150157
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
151158
status: missing XML code comments
152159
processingTarget: missing XML code comments

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

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ configurationSamples:
8383
"LanguageMaps": {
8484
"AreaPath": "Area",
8585
"IterationPath": "Iteration"
86-
}
86+
},
87+
"ProductVersion": "OnPremises"
8788
}
8889
sampleFor: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions
8990
description: missing XML code comments
@@ -124,14 +125,20 @@ options:
124125
type: TfsLanguageMapOptions
125126
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
126127
defaultValue: missing XML code comments
127-
isRequired: true
128+
isRequired: false
128129
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
129130
- parameterName: Name
130131
type: String
131132
description: missing XML code comments
132133
defaultValue: missing XML code comments
133134
isRequired: false
134135
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
136+
- parameterName: ProductVersion
137+
type: TfsProductVersion
138+
description: Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.
139+
defaultValue: missing XML code comments
140+
isRequired: false
141+
dotNetType: MigrationTools.Endpoints.TfsProductVersion, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
135142
- parameterName: Project
136143
type: String
137144
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
@@ -142,7 +149,7 @@ options:
142149
type: String
143150
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
144151
defaultValue: missing XML code comments
145-
isRequired: true
152+
isRequired: false
146153
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
147154
status: missing XML code comments
148155
processingTarget: missing XML code comments

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ configurationSamples:
2020
"Collection": null,
2121
"Project": null,
2222
"Authentication": null,
23-
"ReflectedWorkItemIdField": null,
23+
"ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
2424
"LanguageMaps": {
2525
"AreaPath": "Area",
2626
"IterationPath": "Iteration"
27-
}
27+
},
28+
"ProductVersion": "OnPremises"
2829
}
2930
sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
3031
description: missing XML code comments
@@ -65,14 +66,20 @@ options:
6566
type: TfsLanguageMapOptions
6667
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
6768
defaultValue: missing XML code comments
68-
isRequired: true
69+
isRequired: false
6970
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
7071
- parameterName: Name
7172
type: String
7273
description: missing XML code comments
7374
defaultValue: missing XML code comments
7475
isRequired: false
7576
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
77+
- parameterName: ProductVersion
78+
type: TfsProductVersion
79+
description: Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.
80+
defaultValue: missing XML code comments
81+
isRequired: false
82+
dotNetType: MigrationTools.Endpoints.TfsProductVersion, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
7683
- parameterName: Project
7784
type: String
7885
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
@@ -83,7 +90,7 @@ options:
8390
type: String
8491
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
8592
defaultValue: missing XML code comments
86-
isRequired: true
93+
isRequired: false
8794
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8895
status: missing XML code comments
8996
processingTarget: missing XML code comments

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,12 @@ configurationSamples:
2121
"Project": null,
2222
"Query": null,
2323
"Authentication": null,
24-
"ReflectedWorkItemIdField": null,
24+
"ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
2525
"LanguageMaps": {
2626
"AreaPath": "Area",
2727
"IterationPath": "Iteration"
28-
}
28+
},
29+
"ProductVersion": "OnPremises"
2930
}
3031
sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
3132
description: missing XML code comments
@@ -66,14 +67,20 @@ options:
6667
type: TfsLanguageMapOptions
6768
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
6869
defaultValue: missing XML code comments
69-
isRequired: true
70+
isRequired: false
7071
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
7172
- parameterName: Name
7273
type: String
7374
description: missing XML code comments
7475
defaultValue: missing XML code comments
7576
isRequired: false
7677
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
78+
- parameterName: ProductVersion
79+
type: TfsProductVersion
80+
description: Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.
81+
defaultValue: missing XML code comments
82+
isRequired: false
83+
dotNetType: MigrationTools.Endpoints.TfsProductVersion, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
7784
- parameterName: Project
7885
type: String
7986
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
@@ -90,7 +97,7 @@ options:
9097
type: String
9198
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
9299
defaultValue: missing XML code comments
93-
isRequired: true
100+
isRequired: false
94101
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
95102
status: missing XML code comments
96103
processingTarget: missing XML code comments

‎docs/static/schema/configuration.schema.json‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,10 @@
175175
"description": "missing XML code comments",
176176
"type": "string"
177177
},
178+
"ProductVersion": {
179+
"description": "Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.",
180+
"type": "string"
181+
},
178182
"Project": {
179183
"description": "Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.",
180184
"type": "string"
@@ -193,9 +197,7 @@
193197
"required": [
194198
"Authentication",
195199
"Collection",
196-
"LanguageMaps",
197200
"Project",
198-
"ReflectedWorkItemIdField",
199201
"EndpointType"
200202
]
201203
},
@@ -263,6 +265,10 @@
263265
"description": "missing XML code comments",
264266
"type": "string"
265267
},
268+
"ProductVersion": {
269+
"description": "Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.",
270+
"type": "string"
271+
},
266272
"Project": {
267273
"description": "Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.",
268274
"type": "string"
@@ -281,9 +287,7 @@
281287
"required": [
282288
"Authentication",
283289
"Collection",
284-
"LanguageMaps",
285290
"Project",
286-
"ReflectedWorkItemIdField",
287291
"EndpointType"
288292
]
289293
},
@@ -351,6 +355,10 @@
351355
"description": "missing XML code comments",
352356
"type": "string"
353357
},
358+
"ProductVersion": {
359+
"description": "Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.",
360+
"type": "string"
361+
},
354362
"Project": {
355363
"description": "Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.",
356364
"type": "string"
@@ -369,9 +377,7 @@
369377
"required": [
370378
"Authentication",
371379
"Collection",
372-
"LanguageMaps",
373380
"Project",
374-
"ReflectedWorkItemIdField",
375381
"EndpointType"
376382
]
377383
},
@@ -439,6 +445,10 @@
439445
"description": "missing XML code comments",
440446
"type": "string"
441447
},
448+
"ProductVersion": {
449+
"description": "Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.",
450+
"type": "string"
451+
},
442452
"Project": {
443453
"description": "Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.",
444454
"type": "string"
@@ -475,9 +485,7 @@
475485
"required": [
476486
"Authentication",
477487
"Collection",
478-
"LanguageMaps",
479488
"Project",
480-
"ReflectedWorkItemIdField",
481489
"EndpointType"
482490
]
483491
}

‎docs/static/schema/schema.endpoints.tfsendpoint.json‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@
3333
"description": "missing XML code comments",
3434
"type": "string"
3535
},
36+
"ProductVersion": {
37+
"description": "Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.",
38+
"type": "string"
39+
},
3640
"Project": {
3741
"description": "Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.",
3842
"type": "string"
@@ -45,8 +49,6 @@
4549
"required": [
4650
"authentication",
4751
"collection",
48-
"languageMaps",
49-
"project",
50-
"reflectedWorkItemIdField"
52+
"project"
5153
]
5254
}

‎docs/static/schema/schema.endpoints.tfsteamprojectendpoint.json‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@
3333
"description": "missing XML code comments",
3434
"type": "string"
3535
},
36+
"ProductVersion": {
37+
"description": "Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.",
38+
"type": "string"
39+
},
3640
"Project": {
3741
"description": "Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.",
3842
"type": "string"
@@ -45,8 +49,6 @@
4549
"required": [
4650
"authentication",
4751
"collection",
48-
"languageMaps",
49-
"project",
50-
"reflectedWorkItemIdField"
52+
"project"
5153
]
5254
}

‎docs/static/schema/schema.endpoints.tfsteamsettingsendpoint.json‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@
3333
"description": "missing XML code comments",
3434
"type": "string"
3535
},
36+
"ProductVersion": {
37+
"description": "Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.",
38+
"type": "string"
39+
},
3640
"Project": {
3741
"description": "Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.",
3842
"type": "string"
@@ -45,8 +49,6 @@
4549
"required": [
4650
"authentication",
4751
"collection",
48-
"languageMaps",
49-
"project",
50-
"reflectedWorkItemIdField"
52+
"project"
5153
]
5254
}

‎docs/static/schema/schema.endpoints.tfsworkitemendpoint.json‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@
3333
"description": "missing XML code comments",
3434
"type": "string"
3535
},
36+
"ProductVersion": {
37+
"description": "Specifies the TFS product version for compatibility and feature support. Default is OnPremises for TFS 2013+ and Azure DevOps Server.",
38+
"type": "string"
39+
},
3640
"Project": {
3741
"description": "Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.",
3842
"type": "string"
@@ -49,8 +53,6 @@
4953
"required": [
5054
"authentication",
5155
"collection",
52-
"languageMaps",
53-
"project",
54-
"reflectedWorkItemIdField"
56+
"project"
5557
]
5658
}

0 commit comments

Comments
 (0)