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

Registry-Lookup should not expect assetKind and assetType as mandatory input #298

Open
ChrisKoerber opened this issue Jul 19, 2024 · 3 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation requires workstream approval
Milestone

Comments

@ChrisKoerber
Copy link

What happens?

With #46 assetKind and assetType were introduced in the AAS descriptor as well as in the GetAllAssetAdministrationShellDescriptors operation.

The lookup operation expects them to be mandatory input parameters, which in my opinion should not be the case. They should be optional, allowing general lookups on all available descriptors as well as more specific lookups like stated in the original issue description of @BirgitBoss.

This issue is valid for v3.0 up to v3.0.2 of the Part 2 specification.

Why is this wrong?

As the original issue states assetKind and assetType might OFTEN be used for lookup - but not necessarily ALWAYS.

Furthermore properties are specified optional in the descriptor. So this makes conformant descriptor useless (if missing assetKind and assetType ) since they cannot be used for lookup.

image
image

How should it be fixed?

Change the input parameters assetKind and assetType of GetAllAssetAdministrationShellDescriptors to be optional.
By the way - this is how BaSyx currently implements the interface anyway ;)

@ChrisKoerber ChrisKoerber added the bug Something isn't working label Jul 19, 2024
@ChrisKoerber ChrisKoerber changed the title Replace Title Lookup should not expect assetKind and assetType as mandatory input Jul 19, 2024
@BirgitBoss
Copy link
Collaborator

thank your for your finding: you are right, the specification documentation seems to be buggy.

It should be
assetKind Mand. no Card. 1
assetType Mand. no Card. 1

However, the swagger definition seems correct:

https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRegistryServiceSpecification/V3.0.2_SSP-001#/Asset%20Administration%20Shell%20Registry%20API/GetAllAssetAdministrationShellDescriptors

image

@BirgitBoss BirgitBoss added this to the 3.0.3 milestone Jul 19, 2024
@BirgitBoss BirgitBoss added documentation Improvements or additions to documentation requires workstream approval labels Jul 19, 2024
@ChrisKoerber ChrisKoerber changed the title Lookup should not expect assetKind and assetType as mandatory input Registry-Lookup should not expect assetKind and assetType as mandatory input Jul 25, 2024
@sebbader-sap sebbader-sap modified the milestones: 3.0.3, 3.1 Aug 2, 2024
@sebbader-sap
Copy link
Contributor

Thanks for reporting! It's indeed only affecting the specification.

@sebbader-sap
Copy link
Contributor

Fix is also included in V3.0.3

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

No branches or pull requests

3 participants