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

Add Part 2 Classes #15

Closed
sebbader opened this issue Jul 27, 2022 · 7 comments
Closed

Add Part 2 Classes #15

sebbader opened this issue Jul 27, 2022 · 7 comments
Assignees
Labels
enhancement New feature or request V.1.0.0 Final Release V.1.0.0 following EF processes

Comments

@sebbader
Copy link

The model currently contains only the classes of the AAS metamodel (aka. Part 1) but the API (aka. Part 2) also introduces further classes. One example are the Descriptors for the registry endpoints. I think it's reasonable to also include the Part 2 classes in this repo, maybe as another module (model-api-classes?) or directly in the current model project.

@FrankSchnicke
Copy link
Contributor

I think it makes sense to add the Part 2 models in AAS4J since it fits the goal of providing the common models. I would be in favor of putting them in a 'model-api' project to keep a separation between Part 1 & Part 2.

However, there are two open points:

  • Will we write these classes by hand or also auto-generate from, e.g., RDF? Is there any RDF that will be provided by Plattform Industrie 4.0 for these api models?
  • If we introduce these models, we should also introduce their JSON serialization in my opinion

What do the others think?

@mjacoby
Copy link
Contributor

mjacoby commented Jul 28, 2022

I agree with @FrankSchnicke that we should include de-/serialization, however, this is rather complex task as there are multiple serialization formats and parameters.

Considering the amount of work this requires I would propose to handle it as a separate work package starting after we finished updating Part 1.

@sebbader
Copy link
Author

sebbader commented Aug 4, 2022

@mjacoby:

Considering the amount of work this requires I would propose to handle it as a separate work package starting after we finished updating Part 1.

Completely agreed, especially the different format variations, though only affecting JSON at the moment, give me a lot of headache.

@sebbader
Copy link
Author

sebbader commented Aug 4, 2022

  • Will we write these classes by hand or also auto-generate from, e.g., RDF? Is there any RDF that will be provided by Plattform Industrie 4.0 for these api models?

I have an ontology and shall files for all classes available in a private branch already, so this wouldn't be a showstopper for us.

  • If we introduce these models, we should also introduce their JSON serialization in my opinion

True, we would at least need one JSON Schema file for them. Anyone knows if there is a OpenAPI-to-JSON-Schema translator out there? I have used ones for the other way (JSON Schema file to OpenAPI classes) already but never in this direction.

@twebermartins twebermartins moved this to 🆕 New in Eclipse AAS4J Dev Oct 24, 2022
@twebermartins twebermartins added the enhancement New feature or request label Mar 14, 2023
@twebermartins twebermartins added the V.1.1.0 Final Release V.1.1.0 incl. additional features label May 9, 2023
@twebermartins twebermartins added V.1.0.0 Final Release V.1.0.0 following EF processes and removed V.1.1.0 Final Release V.1.1.0 incl. additional features labels Jun 6, 2023
@twebermartins
Copy link
Contributor

Note, as discussed, we decided that this ticket is relevant for V.1.0.0.

@sebbader-sap sebbader-sap moved this from 🆕 New to 🏗 In progress in Eclipse AAS4J Dev Jun 23, 2023
@sebbader-sap
Copy link
Contributor

Progress is part of sap-contributions#3

@twebermartins twebermartins moved this from 🏗 In progress to 👀 In review in Eclipse AAS4J Dev Dec 6, 2023
@twebermartins twebermartins moved this from 👀 In review to 🏗 In progress in Eclipse AAS4J Dev Dec 6, 2023
@twebermartins twebermartins moved this from 🏗 In progress to 👀 In review in Eclipse AAS4J Dev Dec 6, 2023
@FrankSchnicke
Copy link
Contributor

Closed by #161

@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Eclipse AAS4J Dev Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request V.1.0.0 Final Release V.1.0.0 following EF processes
Projects
Status: Done
Development

No branches or pull requests

5 participants