admin-shell-io / aas-specs-api

Repository of the Asset Administration Shell Specification DTA-01002 API
https://admin-shell-io.github.io/aas-specs-antora/index/home/index.html
Creative Commons Attribution 4.0 International
12 stars 5 forks source link

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

Open ChrisKoerber opened 4 months ago

ChrisKoerber commented 4 months ago

What happens?

With https://github.com/admin-shell-io/aas-specs-api/issues/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 ;)

BirgitBoss commented 4 months ago

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

sebbader-sap commented 3 months ago

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

sebbader-sap commented 3 months ago

Fix is also included in V3.0.3