admin-shell-io / questions-and-answers

This repository aims for providing answers to often asked questions in the context of the Asset Administration Shell.
https://admin-shell-io.github.io/questions-and-answers/
Creative Commons Attribution 4.0 International
24 stars 6 forks source link

Best Practices for Descriptor Endpoints #91

Closed sebbader-sap closed 9 months ago

sebbader-sap commented 1 year ago

Solves #89

sebbader-sap commented 1 year ago

@matgnt can you please check the current state of the PR? Would be great if we get at least one review from an independent party :-).

matgnt commented 1 year ago

@matgnt can you please check the current state of the PR? Would be great if we get at least one review from an independent party :-).

I did add 1 comment with the Dataspace example.

In general, I think it is very difficult for users / developers to understand the difference between repository vs. pure submodel and when to add /submodel and when not and what to expect from those endpoints and consequently to add /$value in some (most) cases.

In general my preferred solution would be, that:

I think whenever the semantics of the content from such and endpoint is known from the enclosing context semanticId, this would be the straight forward way that I would expect as a developer.

sebbader-sap commented 9 months ago

See comments

One bug: protocol versions are an array

Indeed, I have changed the lines.

sebbader-sap commented 9 months ago

@BirgitBoss and @matgnt I have finally integrated your comments. Let's get this done as soon as possible (this year?).

sebbader-sap commented 9 months ago

Merging now, even though some reviews are still open. If needed, content can be adjusted later.

StenGruener commented 9 months ago

👏 thanks everyone for the efforts! great work!