There is an inconsistency between the json schemas and the json field names for the component descriptor
versions. The original spec as well as the schemas use the name srcRefs for the list of source references
in am entry of the resource list.
In the ocm code base the field name srcRef is used for the Go structs as well as the json annotation.
Unfortunately the scheme allows for additional fields, therefore the mismatch never provided an error.
Therefore it might have happened, that wrong component descriptors using the singular form have
been created.
Because of the differentiation of the internal and external representation it is easily possible
to accept both versions for deserialization, but the serialization provides only the correct form, now.
What type of PR is this? (check all applicable)
[ ] 🍕 Feature
[x] 🐛 Bug Fix
[x] 📝 Documentation Update
[ ] 🎨 Style
[ ] 🧑💻 Code Refactor
[ ] 🔥 Performance Improvements
[x] ✅ Test
[ ] 🤖 Build
[ ] 🔁 CI
[ ] 📦 Chore (Release)
[ ] ⏩ Revert
Related Tickets & Documents
Related Issue # (issue)
Closes # (issue)
Fixes # (issue)
Remove if not applicable
Screenshots
Added tests?
[x] 👍 yes
[ ] 🙅 no, because they aren't needed
[ ] 🙋 no, because I need help
[ ] Separate ticket for tests # (issue/pr)
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Added to documentation?
[ ] 📜 README.md
[ ] 🙅 no documentation needed
Checklist:
[ ] My code follows the style guidelines of this project
[ ] I have performed a self-review of my code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have made corresponding changes to the documentation
[ ] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[ ] Any dependent changes have been merged and published in downstream modules
Description
There is an inconsistency between the json schemas and the json field names for the component descriptor versions. The original spec as well as the schemas use the name
srcRefsfor the list of source references in am entry of the resource list.In the ocm code base the field name
srcRefis used for the Go structs as well as the json annotation.Unfortunately the scheme allows for additional fields, therefore the mismatch never provided an error.
Therefore it might have happened, that wrong component descriptors using the singular form have been created.
Because of the differentiation of the internal and external representation it is easily possible to accept both versions for deserialization, but the serialization provides only the correct form, now.
What type of PR is this? (check all applicable)
Related Tickets & Documents
Screenshots
Added tests?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Added to documentation?
Checklist: