Skip to content

[BUG] Do not use keywords in the domain models #468 #320

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

Open
1 task done
BirgitBoss opened this issue Sep 18, 2024 · 3 comments
Open
1 task done

[BUG] Do not use keywords in the domain models #468 #320

BirgitBoss opened this issue Sep 18, 2024 · 3 comments
Labels

Comments

@BirgitBoss
Copy link
Collaborator

What happens?

Copy from admin-shell-io/aas-specs-metamodel#468 by @mristin
...

The class Endpoint contains a property called interface. This makes it ugly for the SDKs to call the property interfacE whenever it is a keyword in the respective language.

Please find attached to this comment a Python snippet (from https://github.com/aas-core-works/aas-core-codegen) listing all the keywords in all the popular programming languages.

Another problematic properties are type, range and result.

keywords-snippet.txt

  • I have signed the required Developer Certificate of Origin (DCO) already.
@BirgitBoss BirgitBoss added the bug Something isn't working label Sep 18, 2024
@BirgitBoss BirgitBoss added this to the V4 milestone Sep 18, 2024
@sebbader-sap sebbader-sap removed this from the V4 milestone Jan 17, 2025
@sebbader-sap
Copy link
Contributor

I don't see a bug in the specification here, rather potential improvement for SDKs.

@sebbader-sap sebbader-sap removed the bug Something isn't working label Jan 17, 2025
@sebbader-sap
Copy link
Contributor

For some reason, also the name of the SubmodelElement File seems to cause problems, at least for the Java generators used by SwaggerHub.
And, even more strange, also the AnnotatedRelationshipElement but not the RelationshipElement...

@sebbader-sap
Copy link
Contributor

At least that's what I noticed when pushing the V3.1_in_review OpenAPI files to SwaggerHub and test the generators there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants