API Documentation

[simogalpa]

It is possible to add some documentation on the REST API provided with the server if present?

Some minimal documentation can be founded on the previous repository but not detailed enough to be really useful.

[mristin]

Hi @simogalpa ,
We could write OpenAPI 3 spec and provide it under /openapi3 route. While we do not use a library that directly binds with the spec, we could at least write a component test to test all the routes with the examples.

Would that work for you?

[simogalpa]

Hi, @mristin I think this solution will work perfectly!

Thank you!

[mristin]

Please give me a coule of days. @MichaelHoffmeisterFesto any considerations/doubts?

[MichaelHoffmeisterFesto]

Hello,
the REST specification of the Package Explorer and the AASX server is a temporary one; for this, only a minimal specification exists: link.

The final specification is just currently worked out. In November, there will be a publication of generic API operations and for April 2021, we're planning to have the final REST spec available. From my point of view, in this period of time, a specification via Swagger will be available.

So, things will change. It will get more categorized (we're talking about some "interfaces") and more genaralized. Therefore, the API signatures will change, I personally would not see the point of describing the REST interface as is more specifically.

Best,
Michael

[mristin]

@MichaelHoffmeisterFesto should we put the link in the Readme? IMO, it belongs to the user manual (i.e. main Readme for the time being) and I wouldn't put it in the documentation for developers.

[leoneversberg]

Hi,
are there any updates on the REST API?
I don't know how to update properties with PUT, even some minimal examples would be helpful!

[BirgitBoss]

The REST API is now published: https://industrialdigitaltwin.org/wp-content/uploads/2021/11/Details_of_the_Asset_Administration_Shell_Part_2_V1.pdf

[juileetikekar]

Hi All, the Aasx-Server is upgraded with new REST-API with ASP.NET. It is also supported with Swagger-Documentaion. The details as below:

Server Endpoint: https://registry.h2894164.stratoserver.net/
Swagger Documentation: https://swagger.h2894164.stratoserver.net/swagger/index.html
API example => Get All Asset Administration Shells: https://swagger.h2894164.stratoserver.net/shells
For more details: https://industrialdigitaltwin.org/wp-content/uploads/2021/11/Details_of_the_Asset_Administration_Shell_Part_2_V1.pdf