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

Library not consistent with V1.1.0 specification #22

Open
jomo02 opened this issue Dec 12, 2022 · 2 comments
Open

Library not consistent with V1.1.0 specification #22

jomo02 opened this issue Dec 12, 2022 · 2 comments

Comments

@jomo02
Copy link

jomo02 commented Dec 12, 2022

Describe the bug
The library is (at some parts) not consistent with the V1.1.0 specification.

Examples I have found so far:

  • Optional State field information should be called informations and be mandatory
  • Enum values of ErrorLevel should be fatal and warning instead of FATAL and WARNING
  • NodePosition field allowedDeviationXy should be called allowedDeviationXY

This is the V1.1.0 specification I'm referring to.

@jomo02
Copy link
Author

jomo02 commented Dec 21, 2022

I found out that this library is probably implemented against the JSON Schema as 'single source of truth' as mentioned in the PDF above.
Meaning that my remarks regarding information, ErrorLevel and allowedDeviationXy can be ignored since they fit with the schema.

However, the actionStatus differs: The schema contains lower case and the library upper case enums. Also paused is missing.

@ghost
Copy link

ghost commented Apr 4, 2023

Thanks for pointing out some of the inconsistencies between VDA 5050 specs and schemas. Yes, I followed the "single source of truth" principle specified in chapter 6 of VDA 5050 v1.1.0 PDF.

You are correct in that casing in enum ActionStatus is wrong in my implementation and that "PAUSED" is part of my schema but the official one is missing a "paused" value. Regarding the missing "paused" value I assume this is an error in the original schema as all VDA 5050 specification versions describe a PAUSED ActionState and its associated logic in their PDF documents. My library implementation is also relying on the Paused state.

I have decided to keep my current JSON schema and implementation "as is" as long as the official VDA 5050 PDF spec and JSON schema are a complete mess regarding consistency. For example, this issue states a decision taken on 2023-03-09 to rename AllowedDeviationXy to AllowedDeviationXY in the schema which contradicts the "single source of truth" principle.

You may open an issue on the official VDA 5050 repo to clarify the missing Paused state.

@ghost ghost closed this as completed Apr 4, 2023
@ghost ghost reopened this Apr 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant