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

[Industry Core KIT] BugFix: remove faulty JSON-examples for aspect models #1056

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

johannsvarela
Copy link
Contributor

@johannsvarela johannsvarela commented Oct 16, 2024

Description

This PR fixes bugs in the JSON-Examples for the SerialPart, Batch and JustInSequencePart aspect models of the section Development View / Aspect Models. For more details have a look at the changelog.

The bugfix will affect these KIT versions:

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

@johannsvarela johannsvarela changed the title Fix: remove faulty JSON-examples for aspect models [Industry Core KIT] Fix: remove faulty JSON-examples for aspect models Oct 16, 2024
@johannsvarela johannsvarela changed the title [Industry Core KIT] Fix: remove faulty JSON-examples for aspect models [Industry Core KIT] fix: remove faulty JSON-examples for aspect models Oct 16, 2024
@johannsvarela johannsvarela self-assigned this Oct 17, 2024
@johannsvarela johannsvarela added the bug Something isn't working label Oct 17, 2024
@@ -293,13 +285,13 @@ Aspect model in GitHub:
"key": "batchId"
},
{
"value": "123-0.740-3434-A",
"key": "manufacturerPartId"
"key": "manufacturerId",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at the batch aspect itself, I still see differences between the semantic model example and how we describe it here. What you did is an improvement, for sure: Would you also remove the resulting differences?
I guess this also applies to the other aspect models

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eckardg regarding the "differences", do you mean changing the examples in the Aspect models?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, currently when I compare the examples in the aspect models and the examples in the KIT I see differences. Wouldn'it it be easier to adapt the examples in the KIT?

Copy link
Contributor

@eckardg eckardg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be great if you could also remove further differences :-)

@arnoweiss
Copy link
Contributor

Can you state the motivation for removing the manufacturerPartId?

@johannsvarela
Copy link
Contributor Author

johannsvarela commented Oct 22, 2024

Can you state the motivation for removing the manufacturerPartId?

@arnoweiss the manufactuererPartid is not part of the LocalIdentifier, but is described in the partTypeInformation section below. Therefore the existing example is faulty.

image

@johannsvarela
Copy link
Contributor Author

It would be great if you could also remove further differences :-)

@eckardg Unfortunately, we cannot use the same examples from the Aspect models for the KITs because the examples from the Aspect models only allow one example per attribute and therefore no list of examples of arrays such as the LocalIdentifiers, sites, or PartClassification can be generated.

If you want, I can harmonize the values from the aspect models with the KIT examples, but the structure in the example in KIT will not be the same as in the apsect models for the reason explained above.

Do you get my point? 😄

Copy link
Contributor

@eckardg eckardg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your explanation. It is now fine for me, thanks!

@johannsvarela johannsvarela changed the title [Industry Core KIT] fix: remove faulty JSON-examples for aspect models [Industry Core KIT] BugFix: remove faulty JSON-examples for aspect models Oct 23, 2024
Copy link
Contributor

@tom-rm-meyer-ISST tom-rm-meyer-ISST left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@johannsvarela
Copy link
Contributor Author

johannsvarela commented Nov 12, 2024

@stephanbcbauer @jSchuetz88 Any updates on this PR? When will this bugfix be merged?

@arnoweiss
Copy link
Contributor

There's conflicts. If you resolve those, I can merge immediately.

Copy link
Member

@jSchuetz88 jSchuetz88 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @johannsvarela, thank you for your contribution.

It took me some time to compare your suggestion against the aspect models, but it makes sense to me. Good to go.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants