Skip to content

Commit 2632f58

Browse files
committed
fix(yaml): update field mappings in TfsWorkItemTypeValidatorTool configuration
1 parent d44b27c commit 2632f58

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ configurationSamples:
1919
"$type": "TfsWorkItemTypeValidatorToolOptions",
2020
"Enabled": true,
2121
"IncludeWorkItemtypes": [],
22-
"FieldMappings": {}
22+
"SourceFieldMappings": {},
23+
"FixedTargetFields": {}
2324
}
2425
sampleFor: MigrationTools.Tools.TfsWorkItemTypeValidatorToolOptions
2526
description: missing XML code comments
@@ -30,14 +31,18 @@ options:
3031
type: Boolean
3132
description: If set to `true` then the tool will run. Set to `false` and the processor will not run.
3233
defaultValue: missing XML code comments
33-
- parameterName: FieldMappings
34+
- parameterName: FixedTargetFields
3435
type: Dictionary
35-
description: Field reference name mappings. Key is work item type name, value is dictionary of mapping source filed name to target field name. Target field name can be empty string to indicate that this field will not be validated in target. As work item type name, you can use * to define mappings which will be applied to all work item types.
36+
description: List of target fields, that are considered as fixed. It means, even if the field is different against source field, no warning will be triggered, jus information about the differences. Use this list, whan you know about the differences between fields, but resolved it for example by using . Key is target work item type name. As this name, you can use * to define fixed fields which will be applied to all work item types.
3637
defaultValue: missing XML code comments
3738
- parameterName: IncludeWorkItemtypes
3839
type: List
3940
description: List of work item types which will be validated. If this list is empty, all work item types will be validated.
4041
defaultValue: missing XML code comments
42+
- parameterName: SourceFieldMappings
43+
type: Dictionary
44+
description: Field reference name mappings. Key is work item type name, value is dictionary of mapping source filed name to target field name. Target field name can be empty string to indicate that this field will not be validated in target. As work item type name, you can use * to define mappings which will be applied to all work item types.
45+
defaultValue: missing XML code comments
4146
status: missing XML code comments
4247
processingTarget: missing XML code comments
4348
classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/TfsWorkItemTypeValidatorTool.cs

0 commit comments

Comments
 (0)