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 6 forks source link

Redundant /submodel Path #51

Open sebbader-sap opened 1 year ago

sebbader-sap commented 1 year ago

What?

https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShell-Environment/V1.0RC03#/Asset%20Administration%20Shell%20Environment%20API/GetSubmodel has the path /shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel but similar paths like /submodels/{submodelIdentifier}/submodel-elements (https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShell-Environment/V1.0RC03#/Asset%20Administration%20Shell%20Environment%20API/GetAllSubmodelElements_SubmodelRepo) don't have the "/submodel" part.

How?

Remove "/submodel"

sebbader-sap commented 1 year ago

This change won't be part of V3.0 but introduces a breaking change. Therefore assigning it to a potential V4.0.

BirgitBoss commented 1 year ago

why don't we fix it?

BirgitBoss commented 11 months ago

In contrast we saw that with profile definition the /submodel is extremely helpful. So add it (again) to the repository Get submodel operations. (See CX-0002 in https://catena-x.net/de/standard-library how complicated it is to explain that it does not matter whether you add a GetSubmodel Operation via repository or via a single submodel server.

sebbader-sap commented 11 months ago

I remember that we had many findings in the Release Candidate reviews asking for the removal of the "/submodel" path segment for Submodel Repository endpoints. I think this is a symptom of a broader "symmetry" discussion which we need to have sooner or later.

sebbader-sap commented 11 months ago

Adding already in V3.x (and consequently allowing the .../{submodelIdentifier}/submodel and /{submodelIdentifier} at the same time) gives me a bad feeling...