Skip to content

Define systematic URLs into the online repo #463

@mrentsch65

Description

@mrentsch65

What is missing?

The following items are accessible via the webpage https://smt-repo.admin-shell-io.com/ (here i.e. for the SM IntelligentInformationforUse):
Image
These items are however not linkable, instead downloads are immediately started, which is unsuitable to be used in the context of other software tools, i.e. for implementing online help functionalities.

Just the PDF and API can be linked according to the following system:
https://smt-repo.admin-shell-io.com/static/pdf/IDTA_02063-1-0_Submodel__IntelligentInformationForUse.pdf
https://smt-repo.admin-shell-io.com/api/v3.0/submodels/aHR0cHM6Ly9hZG1pbi1zaGVsbC5pby9pZHRhL1N1Ym1vZGVsVGVtcGxhdGUvSW50ZWxsaWdlbnRJbmZvcm1hdGlvbkZvclVzZS8xLzA=

How should it be fixed?

Define and implement an easy-to-use and logterm-stable API and/or systematic URL link structure to the topics presented there, This is solvable via different approaches, the most elegant would be IMO to use the same basic structure as in the reference IRIs of the specification elements and implement them as URLs i.e. for the SM IntelligentInformationforUse, which has the reference IRI "https://admin-shell.io/idta/IntelligentInformationForUse/1/0", the following API could be defined:
https://repo.admin-shell-io.com/idta/IntelligentInformationForUse/1/0 and query-parameters (JSON, AASX, XML, PDF, API) to retrieve the desired representation.
Additionally or alternatively, direct links to the information resources could also be defined, i.e.
https://repo.admin-shell-io.com/idta/IntelligentInformationForUse/IDTA_02063-1-0_Submodel__IntelligentInformationForUse.pdf
https://repo.admin-shell-io.com/idta/IntelligentInformationForUse/IDTA_02063-1-0_Submodel__IntelligentInformationForUse.aasx
etc..

This would allow as a side effect precise referencing of the specification documents, which is currently only feasible with the Github-Links.

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions