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

Should AID tools name be changed to interfaceS ? #1235

Closed
egekorkan opened this issue Feb 11, 2024 · 4 comments
Closed

Should AID tools name be changed to interfaceS ? #1235

egekorkan opened this issue Feb 11, 2024 · 4 comments
Labels

Comments

@egekorkan
Copy link
Member

The AID spec is now called Asset Interfaces Description but the tooling is called Asset Interface Description. This is in the readme but also in the code. Probably better to do this when moving to td-tools?

Note: definitely nitpicking :)

@egekorkan egekorkan changed the title Should AID tools name changed interfaceS ? Should AID tools name be changed to interfaceS ? Feb 11, 2024
@danielpeintner
Copy link
Member

Yes, renaming can be done when moving to td-tools. I wouldn't do it earlier...

@danielpeintner
Copy link
Member

It seems the naming is not consistent.

On https://github.com/admin-shell-io/submodel-templates/tree/main/development/Asset%20Interface%20Description/1/0 the singular is still used for the title and the URL !?

@Kaz040 @sebastiankb what term should be used?

Asset Interface Description (status quo)
vs.
Asset Interfaces Description (proposed by @egekorkan )

Note: in the source code for semanticId we seem to use both singular & plural. I can find

  • https://admin-shell.io/idta/AssetInterfaceDescription/1/0/PropertyDefinition but also
  • https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata etc

Is the singular version wrong now?

@Kaz040
Copy link
Contributor

Kaz040 commented Mar 21, 2024

@danielpeintner, The official valid name is Asset Interfaces Description

Earlier when the WG started, it was Asset Interface Description but along the line we changed it to Asset Interfaces Description. The naming on the repo and also the readme in the development repo https://github.com/admin-shell-io/submodel-templates/tree/main/development/Asset%20Interface%20Description/1/0 is wrong and would need to be updated to include the "s".

But the published repo https://github.com/admin-shell-io/submodel-templates/tree/main/published/Asset%20Interfaces%20Description/1/0 is correct which is where we will put all implementation links.

about the semanticId, I think it should be a mistake from the source code. In the official document, it is https://admin-shell.io/idta/AssetInterfacesDescription/1/0/PropertyDefinition.

I just added an excel sheet that contains the list of terms with semanticIds and supplementary semanticIds to the folder (AID2TD_Test_AASs/AID_Document) I shared sometime last year. I added this file because perhaps there might be some other terms that might be having wrong semanticId.

@danielpeintner
Copy link
Member

Closing, eclipse-thingweb/td-tools#7 has been merged

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

3 participants