Align OutputConfigurationQuery/Configuration for sourceTypeId #121
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PatrickTasse
requested changes
Nov 11, 2024
| * @param typeId The ID of the configuration source type | ||
| * @param parameters Object used to send parameters to the server | ||
| */ | ||
| constructor(name: string, description: string | undefined, typeId: string, parameters: Object) { |
Contributor
There was a problem hiding this comment.
Should this be sourceTypeId? Also double spaces.
In the OutputConfigurationQuery the configuration source type id was called typeId and it creates a Configuration object where the same field is called sourceTypeId for the same field. When serializing the Configuration in the derived DataProviderDescriptor over TSP the field is called sourceTypeId and this is not consistent. The returned Configuration should have the exact field names that are used when creating the data provider and the respective configuration. The Configuration is already API while OutputConfigurationQuery is not, and it's better to change the name there. Signed-off-by: Bernd Hufmann <[email protected]>
bhufmann
force-pushed
the
rename-to-sourceTypeId
branch
from
86da09b to
7ad4422
Compare
PatrickTasse
approved these changes
Nov 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the OutputConfigurationQuery the configuration source type id was called typeId and it creates a Configuration object where the same field is called sourceTypeId for the same field. When serializing the Configuration in the derived DataProviderDescriptor over TSP the field is called sourceTypeId and this is not consistent. The returned Configuration should have the exact field names that are used when creating the data provider and the respective configuration.
The Configuration is already API while OutputConfigurationQuery is not, and it's better to change the name there.
Signed-off-by: Bernd Hufmann [email protected]