Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align Terminology of Model Classes / Public API #70

Closed
wba2hi opened this issue Jan 30, 2024 · 0 comments · Fixed by #94
Closed

Align Terminology of Model Classes / Public API #70

wba2hi opened this issue Jan 30, 2024 · 0 comments · Fixed by #94
Labels
breaking change This issue may introduce a breaking change
Milestone

Comments

@wba2hi
Copy link
Contributor

wba2hi commented Jan 30, 2024

Is your feature request related to a problem? Please describe.
Our terminology used inside the SDK is not consistent to the "real world". While the "VSS Specification" contains a list of all Vehicle Signals, we have a base class named "VssSpecification". All our generated classes extend this "VssSpecification".
While it's true, that each of these classes are part of the VssSpecification each element on it's own is not the "VssSpecification".

Same with the annotation. The only annotation which is used to reference the VssSpecification file is named "VssDefinition". While this is a valid name, a more appropriate name would be "VssSpecification".

PropertyListener also is chosen arbitrarily but it also probably needs the same name

The naming "VssSpecification is also redundant as VSS means "Vehicle Signal Specification". Therefore A VssSpecification is a "Vehicle Signal Specification Specification" :D

Describe the solution you'd like

  • Rename VssDefinition -> Vs(s)Specification
  • Rename VssSpecification -> VssSignal / VssElement / VssNode / ...
  • Rename VssSpecificationListener -> VssSignalListener (?)
  • Rename PropertyListener -> VssSignalListener (?)
  • check other models for inconsistencies with "common names"
@Chrylo Chrylo added this to the 0.2 milestone Feb 27, 2024
@Chrylo Chrylo added the breaking change This issue may introduce a breaking change label Feb 27, 2024
Chrylo added a commit to boschglobal/kuksa-android-sdk that referenced this issue Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change This issue may introduce a breaking change
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants