Skip to content

Commit 8c97a0d

Browse files
committed
Refactor schema property names to use PascalCase for consistency across tools
- Updated JSON schema files for various tools to change property names from camelCase to PascalCase (e.g., "enabled" to "Enabled"). - Ensured that descriptions and types remain unchanged to maintain functionality. - Enhanced the ClassDataLoader to capture the .NET type of properties for improved schema generation. - Introduced a new contract resolver in DataSerialization to filter JSON output, focusing on public read/write properties and excluding internal members. - Added methods to handle complex types and collections in schema generation, improving the overall schema structure.
1 parent 8b5d34f commit 8c97a0d

File tree

111 files changed

+2107
-1171
lines changed

Some content is hidden

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

111 files changed

+2107
-1171
lines changed

.vscode/launch.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
55
"version": "0.2.0",
66
"configurations": [
7+
78
{
89
"name": "PowerShell Launch Current File",
910
"type": "PowerShell",

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

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,42 +47,50 @@ 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: true
50+
isRequired: false
51+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
5152
- parameterName: AuthenticationMode
5253
type: AuthenticationMode
5354
description: Authentication mode to use when connecting to Azure DevOps. Typically uses AccessToken for modern Azure DevOps organizations.
5455
defaultValue: missing XML code comments
55-
isRequired: true
56+
isRequired: false
57+
dotNetType: MigrationTools.Endpoints.AuthenticationMode, MigrationTools, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
5658
- parameterName: Enabled
5759
type: Boolean
5860
description: Will be used if enabled
5961
defaultValue: missing XML code comments
6062
isRequired: false
63+
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
6164
- parameterName: EndpointEnrichers
6265
type: List
6366
description: missing XML code comments
6467
defaultValue: missing XML code comments
6568
isRequired: false
69+
dotNetType: System.Collections.Generic.List`1[[MigrationTools.EndpointEnrichers.IEndpointEnricherOptions, MigrationTools, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
6670
- parameterName: Name
6771
type: String
6872
description: missing XML code comments
6973
defaultValue: missing XML code comments
7074
isRequired: false
75+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
7176
- parameterName: Organisation
7277
type: String
7378
description: URL of the Azure DevOps organization (e.g., "https://dev.azure.com/myorganization/"). Must include the full organization URL.
7479
defaultValue: missing XML code comments
75-
isRequired: true
80+
isRequired: false
81+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
7682
- parameterName: Project
7783
type: String
7884
description: Name of the Azure DevOps project within the organization to connect to. This is the project that will be used for migration operations.
7985
defaultValue: missing XML code comments
80-
isRequired: true
86+
isRequired: false
87+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8188
- parameterName: ReflectedWorkItemIdField
8289
type: String
8390
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
8491
defaultValue: missing XML code comments
85-
isRequired: true
92+
isRequired: false
93+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8694
status: missing XML code comments
8795
processingTarget: missing XML code comments
8896
classFile: src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpoint.cs

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,25 @@ options:
2929
description: Will be used if enabled
3030
defaultValue: missing XML code comments
3131
isRequired: false
32+
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
3233
- parameterName: EndpointEnrichers
3334
type: List
3435
description: missing XML code comments
3536
defaultValue: missing XML code comments
3637
isRequired: false
38+
dotNetType: System.Collections.Generic.List`1[[MigrationTools.EndpointEnrichers.IEndpointEnricherOptions, MigrationTools, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
3739
- parameterName: FileStore
3840
type: String
3941
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.
4042
defaultValue: missing XML code comments
4143
isRequired: false
44+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
4245
- parameterName: Name
4346
type: String
4447
description: missing XML code comments
4548
defaultValue: missing XML code comments
4649
isRequired: false
50+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
4751
status: missing XML code comments
4852
processingTarget: missing XML code comments
4953
classFile: src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpoint.cs

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

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,46 +99,55 @@ options:
9999
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.
100100
defaultValue: missing XML code comments
101101
isRequired: false
102+
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
102103
- parameterName: Authentication
103104
type: TfsAuthenticationOptions
104105
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
105106
defaultValue: missing XML code comments
106-
isRequired: true
107+
isRequired: false
108+
dotNetType: MigrationTools.Endpoints.Infrastructure.TfsAuthenticationOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
107109
- parameterName: Collection
108110
type: Uri
109111
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
110112
defaultValue: missing XML code comments
111-
isRequired: true
113+
isRequired: false
114+
dotNetType: System.Uri, System.Private.Uri, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
112115
- parameterName: Enabled
113116
type: Boolean
114117
description: Will be used if enabled
115118
defaultValue: missing XML code comments
116119
isRequired: false
120+
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
117121
- parameterName: EndpointEnrichers
118122
type: List
119123
description: missing XML code comments
120124
defaultValue: missing XML code comments
121125
isRequired: false
126+
dotNetType: System.Collections.Generic.List`1[[MigrationTools.EndpointEnrichers.IEndpointEnricherOptions, MigrationTools, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
122127
- parameterName: LanguageMaps
123128
type: TfsLanguageMapOptions
124129
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
125130
defaultValue: missing XML code comments
126-
isRequired: true
131+
isRequired: false
132+
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
127133
- parameterName: Name
128134
type: String
129135
description: missing XML code comments
130136
defaultValue: missing XML code comments
131137
isRequired: false
138+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
132139
- parameterName: Project
133140
type: String
134141
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
135142
defaultValue: missing XML code comments
136-
isRequired: true
143+
isRequired: false
144+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
137145
- parameterName: ReflectedWorkItemIdField
138146
type: String
139147
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
140148
defaultValue: missing XML code comments
141-
isRequired: true
149+
isRequired: false
150+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
142151
status: missing XML code comments
143152
processingTarget: missing XML code comments
144153
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpoint.cs

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

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,46 +95,55 @@ options:
9595
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.
9696
defaultValue: missing XML code comments
9797
isRequired: false
98+
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
9899
- parameterName: Authentication
99100
type: TfsAuthenticationOptions
100101
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
101102
defaultValue: missing XML code comments
102-
isRequired: true
103+
isRequired: false
104+
dotNetType: MigrationTools.Endpoints.Infrastructure.TfsAuthenticationOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
103105
- parameterName: Collection
104106
type: Uri
105107
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
106108
defaultValue: missing XML code comments
107-
isRequired: true
109+
isRequired: false
110+
dotNetType: System.Uri, System.Private.Uri, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
108111
- parameterName: Enabled
109112
type: Boolean
110113
description: Will be used if enabled
111114
defaultValue: missing XML code comments
112115
isRequired: false
116+
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
113117
- parameterName: EndpointEnrichers
114118
type: List
115119
description: missing XML code comments
116120
defaultValue: missing XML code comments
117121
isRequired: false
122+
dotNetType: System.Collections.Generic.List`1[[MigrationTools.EndpointEnrichers.IEndpointEnricherOptions, MigrationTools, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
118123
- parameterName: LanguageMaps
119124
type: TfsLanguageMapOptions
120125
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
121126
defaultValue: missing XML code comments
122-
isRequired: true
127+
isRequired: false
128+
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
123129
- parameterName: Name
124130
type: String
125131
description: missing XML code comments
126132
defaultValue: missing XML code comments
127133
isRequired: false
134+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
128135
- parameterName: Project
129136
type: String
130137
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
131138
defaultValue: missing XML code comments
132-
isRequired: true
139+
isRequired: false
140+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
133141
- parameterName: ReflectedWorkItemIdField
134142
type: String
135143
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
136144
defaultValue: missing XML code comments
137-
isRequired: true
145+
isRequired: false
146+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
138147
status: missing XML code comments
139148
processingTarget: missing XML code comments
140149
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndpoint.cs

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

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,46 +36,55 @@ options:
3636
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.
3737
defaultValue: missing XML code comments
3838
isRequired: false
39+
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
3940
- parameterName: Authentication
4041
type: TfsAuthenticationOptions
4142
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
4243
defaultValue: missing XML code comments
43-
isRequired: true
44+
isRequired: false
45+
dotNetType: MigrationTools.Endpoints.Infrastructure.TfsAuthenticationOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
4446
- parameterName: Collection
4547
type: Uri
4648
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
4749
defaultValue: missing XML code comments
48-
isRequired: true
50+
isRequired: false
51+
dotNetType: System.Uri, System.Private.Uri, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
4952
- parameterName: Enabled
5053
type: Boolean
5154
description: Will be used if enabled
5255
defaultValue: missing XML code comments
5356
isRequired: false
57+
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
5458
- parameterName: EndpointEnrichers
5559
type: List
5660
description: missing XML code comments
5761
defaultValue: missing XML code comments
5862
isRequired: false
63+
dotNetType: System.Collections.Generic.List`1[[MigrationTools.EndpointEnrichers.IEndpointEnricherOptions, MigrationTools, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
5964
- parameterName: LanguageMaps
6065
type: TfsLanguageMapOptions
6166
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
6267
defaultValue: missing XML code comments
63-
isRequired: true
68+
isRequired: false
69+
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
6470
- parameterName: Name
6571
type: String
6672
description: missing XML code comments
6773
defaultValue: missing XML code comments
6874
isRequired: false
75+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
6976
- parameterName: Project
7077
type: String
7178
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
7279
defaultValue: missing XML code comments
73-
isRequired: true
80+
isRequired: false
81+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
7482
- parameterName: ReflectedWorkItemIdField
7583
type: String
7684
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
7785
defaultValue: missing XML code comments
78-
isRequired: true
86+
isRequired: false
87+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
7988
status: missing XML code comments
8089
processingTarget: missing XML code comments
8190
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpoint.cs

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

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,51 +37,61 @@ options:
3737
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.
3838
defaultValue: missing XML code comments
3939
isRequired: false
40+
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
4041
- parameterName: Authentication
4142
type: TfsAuthenticationOptions
4243
description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
4344
defaultValue: missing XML code comments
44-
isRequired: true
45+
isRequired: false
46+
dotNetType: MigrationTools.Endpoints.Infrastructure.TfsAuthenticationOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
4547
- parameterName: Collection
4648
type: Uri
4749
description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
4850
defaultValue: missing XML code comments
49-
isRequired: true
51+
isRequired: false
52+
dotNetType: System.Uri, System.Private.Uri, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
5053
- parameterName: Enabled
5154
type: Boolean
5255
description: Will be used if enabled
5356
defaultValue: missing XML code comments
5457
isRequired: false
58+
dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
5559
- parameterName: EndpointEnrichers
5660
type: List
5761
description: missing XML code comments
5862
defaultValue: missing XML code comments
5963
isRequired: false
64+
dotNetType: System.Collections.Generic.List`1[[MigrationTools.EndpointEnrichers.IEndpointEnricherOptions, MigrationTools, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
6065
- parameterName: LanguageMaps
6166
type: TfsLanguageMapOptions
6267
description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
6368
defaultValue: missing XML code comments
64-
isRequired: true
69+
isRequired: false
70+
dotNetType: MigrationTools.Endpoints.TfsLanguageMapOptions, MigrationTools.Clients.TfsObjectModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
6571
- parameterName: Name
6672
type: String
6773
description: missing XML code comments
6874
defaultValue: missing XML code comments
6975
isRequired: false
76+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
7077
- parameterName: Project
7178
type: String
7279
description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
7380
defaultValue: missing XML code comments
74-
isRequired: true
81+
isRequired: false
82+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
7583
- parameterName: Query
7684
type: QueryOptions
7785
description: Gets or sets the query options that define which work items to retrieve from the source endpoint, including WIQL queries and parameters.
7886
defaultValue: missing XML code comments
7987
isRequired: false
88+
dotNetType: MigrationTools.Options.QueryOptions, MigrationTools, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
8089
- parameterName: ReflectedWorkItemIdField
8190
type: String
8291
description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
8392
defaultValue: missing XML code comments
84-
isRequired: true
93+
isRequired: false
94+
dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
8595
status: missing XML code comments
8696
processingTarget: missing XML code comments
8797
classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpoint.cs

0 commit comments

Comments
 (0)