Skip to content

Commit ca79339

Browse files
committed
Generate docs
1 parent ab875ea commit ca79339

File tree

80 files changed

+999
-15
lines changed

Some content is hidden

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

80 files changed

+999
-15
lines changed

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,18 @@ options:
5151
type: AuthenticationMode
5252
description: Authentication mode to use when connecting to Azure DevOps. Typically uses AccessToken for modern Azure DevOps organizations.
5353
defaultValue: missing XML code comments
54+
- parameterName: Enabled
55+
type: Boolean
56+
description: Will be used if enabled
57+
defaultValue: missing XML code comments
58+
- parameterName: EndpointEnrichers
59+
type: List
60+
description: missing XML code comments
61+
defaultValue: missing XML code comments
62+
- parameterName: Name
63+
type: String
64+
description: missing XML code comments
65+
defaultValue: missing XML code comments
5466
- parameterName: Organisation
5567
type: String
5668
description: URL of the Azure DevOps organization (e.g., "https://dev.azure.com/myorganization/"). Must include the full organization URL.

docs/data/classes/reference.endpoints.filesystemworkitemendpoint.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,22 @@ description: missing XML code comments
2424
className: FileSystemWorkItemEndpoint
2525
typeName: Endpoints
2626
options:
27+
- parameterName: Enabled
28+
type: Boolean
29+
description: Will be used if enabled
30+
defaultValue: missing XML code comments
31+
- parameterName: EndpointEnrichers
32+
type: List
33+
description: missing XML code comments
34+
defaultValue: missing XML code comments
2735
- parameterName: FileStore
2836
type: String
2937
description: Path to the directory where work item data will be stored or read from. This should be a valid local file system path with appropriate read/write permissions.
3038
defaultValue: missing XML code comments
39+
- parameterName: Name
40+
type: String
41+
description: missing XML code comments
42+
defaultValue: missing XML code comments
3143
status: missing XML code comments
3244
processingTarget: missing XML code comments
3345
classFile: src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpoint.cs

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,10 @@ description: missing XML code comments
9494
className: TfsEndpoint
9595
typeName: Endpoints
9696
options:
97+
- parameterName: AllowCrossProjectLinking
98+
type: Boolean
99+
description: When true, allows work items to link to items in different projects within the same collection. Default is false for security and organizational clarity.
100+
defaultValue: missing XML code comments
97101
- parameterName: Authentication
98102
type: TfsAuthenticationOptions
99103
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
@@ -102,10 +106,22 @@ options:
102106
type: Uri
103107
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
104108
defaultValue: missing XML code comments
109+
- parameterName: Enabled
110+
type: Boolean
111+
description: Will be used if enabled
112+
defaultValue: missing XML code comments
113+
- parameterName: EndpointEnrichers
114+
type: List
115+
description: missing XML code comments
116+
defaultValue: missing XML code comments
105117
- parameterName: LanguageMaps
106118
type: TfsLanguageMapOptions
107119
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
108120
defaultValue: missing XML code comments
121+
- parameterName: Name
122+
type: String
123+
description: missing XML code comments
124+
defaultValue: missing XML code comments
109125
- parameterName: Project
110126
type: String
111127
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,10 @@ description: missing XML code comments
9090
className: TfsTeamProjectEndpoint
9191
typeName: Endpoints
9292
options:
93+
- parameterName: AllowCrossProjectLinking
94+
type: Boolean
95+
description: When true, allows work items to link to items in different projects within the same collection. Default is false for security and organizational clarity.
96+
defaultValue: missing XML code comments
9397
- parameterName: Authentication
9498
type: TfsAuthenticationOptions
9599
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
@@ -98,10 +102,22 @@ options:
98102
type: Uri
99103
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
100104
defaultValue: missing XML code comments
105+
- parameterName: Enabled
106+
type: Boolean
107+
description: Will be used if enabled
108+
defaultValue: missing XML code comments
109+
- parameterName: EndpointEnrichers
110+
type: List
111+
description: missing XML code comments
112+
defaultValue: missing XML code comments
101113
- parameterName: LanguageMaps
102114
type: TfsLanguageMapOptions
103115
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
104116
defaultValue: missing XML code comments
117+
- parameterName: Name
118+
type: String
119+
description: missing XML code comments
120+
defaultValue: missing XML code comments
105121
- parameterName: Project
106122
type: String
107123
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ description: missing XML code comments
3131
className: TfsTeamSettingsEndpoint
3232
typeName: Endpoints
3333
options:
34+
- parameterName: AllowCrossProjectLinking
35+
type: Boolean
36+
description: When true, allows work items to link to items in different projects within the same collection. Default is false for security and organizational clarity.
37+
defaultValue: missing XML code comments
3438
- parameterName: Authentication
3539
type: TfsAuthenticationOptions
3640
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
@@ -39,10 +43,22 @@ options:
3943
type: Uri
4044
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
4145
defaultValue: missing XML code comments
46+
- parameterName: Enabled
47+
type: Boolean
48+
description: Will be used if enabled
49+
defaultValue: missing XML code comments
50+
- parameterName: EndpointEnrichers
51+
type: List
52+
description: missing XML code comments
53+
defaultValue: missing XML code comments
4254
- parameterName: LanguageMaps
4355
type: TfsLanguageMapOptions
4456
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
4557
defaultValue: missing XML code comments
58+
- parameterName: Name
59+
type: String
60+
description: missing XML code comments
61+
defaultValue: missing XML code comments
4662
- parameterName: Project
4763
type: String
4864
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ description: missing XML code comments
3232
className: TfsWorkItemEndpoint
3333
typeName: Endpoints
3434
options:
35+
- parameterName: AllowCrossProjectLinking
36+
type: Boolean
37+
description: When true, allows work items to link to items in different projects within the same collection. Default is false for security and organizational clarity.
38+
defaultValue: missing XML code comments
3539
- parameterName: Authentication
3640
type: TfsAuthenticationOptions
3741
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
@@ -40,10 +44,22 @@ options:
4044
type: Uri
4145
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
4246
defaultValue: missing XML code comments
47+
- parameterName: Enabled
48+
type: Boolean
49+
description: Will be used if enabled
50+
defaultValue: missing XML code comments
51+
- parameterName: EndpointEnrichers
52+
type: List
53+
description: missing XML code comments
54+
defaultValue: missing XML code comments
4355
- parameterName: LanguageMaps
4456
type: TfsLanguageMapOptions
4557
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
4658
defaultValue: missing XML code comments
59+
- parameterName: Name
60+
type: String
61+
description: missing XML code comments
62+
defaultValue: missing XML code comments
4763
- parameterName: Project
4864
type: String
4965
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.

docs/data/classes/reference.fieldmaps.fieldcalculationmap.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ options:
7979
type: List
8080
description: A list of Work Item Types that this Field Map will apply to. If the list is empty it will apply to all Work Item Types. You can use "*" to apply to all Work Item Types.
8181
defaultValue: missing XML code comments
82+
- parameterName: Enabled
83+
type: Boolean
84+
description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
85+
defaultValue: missing XML code comments
8286
- parameterName: expression
8387
type: String
8488
description: Gets or sets the NCalc expression to evaluate. Variables in the expression should be enclosed in square brackets (e.g., "[x]*2").

docs/data/classes/reference.fieldmaps.fieldclearmap.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,10 @@ options:
6767
type: List
6868
description: A list of Work Item Types that this Field Map will apply to. If the list is empty it will apply to all Work Item Types. You can use "*" to apply to all Work Item Types.
6969
defaultValue: missing XML code comments
70+
- parameterName: Enabled
71+
type: Boolean
72+
description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
73+
defaultValue: missing XML code comments
7074
- parameterName: targetField
7175
type: String
7276
description: Gets or sets the name of the target field to be cleared/set to null during work item migration.

docs/data/classes/reference.fieldmaps.fieldliteralmap.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ options:
6969
type: List
7070
description: A list of Work Item Types that this Field Map will apply to. If the list is empty it will apply to all Work Item Types. You can use "*" to apply to all Work Item Types.
7171
defaultValue: missing XML code comments
72+
- parameterName: Enabled
73+
type: Boolean
74+
description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
75+
defaultValue: missing XML code comments
7276
- parameterName: targetField
7377
type: String
7478
description: Gets or sets the name of the target field that will be set to the specified literal value.

docs/data/classes/reference.fieldmaps.fieldmergemap.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ options:
7777
type: List
7878
description: A list of Work Item Types that this Field Map will apply to. If the list is empty it will apply to all Work Item Types. You can use "*" to apply to all Work Item Types.
7979
defaultValue: missing XML code comments
80+
- parameterName: Enabled
81+
type: Boolean
82+
description: If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.
83+
defaultValue: missing XML code comments
8084
- parameterName: formatExpression
8185
type: String
8286
description: missing XML code comments

0 commit comments

Comments
 (0)