chore(docs):[eclipse-tractusx#529] Add semantic model links to docume…

…ntation
dsmf · Jun 12, 2024 · 34a05fd · 34a05fd
1 parent ec5b48f
commit 34a05fd
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 19 deletions.
diff --git a/COMPATIBILITY_MATRIX.md b/COMPATIBILITY_MATRIX.md
@@ -4,20 +4,20 @@ Full changelog of IRS: [changelog](CHANGELOG.md)
 
 ## [Unreleased]
 
-| Dependency                | Version                      | Helm  | Comments        |
-|---------------------------|------------------------------|-------|-----------------|
-| EDC                       | 0.7.0                        | 0.7.0 |                 |
-| Semantics Hub             | 0.3.1                        | 0.2.1 | REST connection |
-| DTR                       | 0.4.1                        | 0.4.9 | REST connection |
-| Discovery Finder          | 0.2.5                        | -     | REST connection |
-| Minio                     | RELEASE.2022-11-11T03-44-20Z | 5.0.1 |                 |
-| Helm                      | 3.9.3                        | -     | -               |
-| Kubernetes                | 1.29                         | -     | -               |
-| SingleLevelBomAsBuilt     | [ 2.0.0; 3.0.0 ]             | -     | Model version   |
-| SingleLevelBomAsPlanned   | [ 2.0.0; 3.0.0 ]             | -     | Model version   |
-| SingleLevelBomAsSpecified | 2.0.0                        | -     | Model version   |
-| SingleLevelUsageAsBuilt   | 3.0.0                        | -     | Model version   |
-| SingleLevelUsageAsPlanned | 2.0.0                        | -     | Model version   |
+| Dependency                                                                                                                                    | Version                      | Helm  | Comments        |
+|-----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|-------|-----------------|
+| EDC                                                                                                                                           | 0.7.0                        | 0.7.0 |                 |
+| Semantics Hub                                                                                                                                 | 0.3.1                        | 0.2.1 | REST connection |
+| DTR                                                                                                                                           | 0.4.1                        | 0.4.9 | REST connection |
+| Discovery Finder                                                                                                                              | 0.2.5                        | -     | REST connection |
+| Minio                                                                                                                                         | RELEASE.2022-11-11T03-44-20Z | 5.0.1 |                 |
+| Helm                                                                                                                                          | 3.9.3                        | -     | -               |
+| Kubernetes                                                                                                                                    | 1.29                         | -     | -               |
+| [SingleLevelBomAsBuilt](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_built)              | [ 2.0.0; 3.0.0 ]             | -     | Model version   |
+| [SingleLevelBomAsPlanned](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_planned)          | [ 2.0.0; 3.0.0 ]             | -     | Model version   |
+| [SingleLevelBomAsSpecified](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_specified)      | 2.0.0                        | -     | Model version   |
+| [SingleLevelUsageAsBuilt](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_usage_as_built)          | 3.0.0                        | -     | Model version   |
+| [SingleLevelUsageAsPlanned](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_usage_as_planned) | 2.0.0                        | -     | Model version   |
 
 ## [CATENA-X Release 24.05](https://eclipse-tractusx.github.io/CHANGELOG/) - [5.1.3](https://github.com/eclipse-tractusx/item-relationship-service/releases/tag/5.1.3) - 2024-05-17
 

diff --git a/...ct-model-SingleLevelBomAsBuilt-2_0_0/#212-Update-SingleLevelBomAsBuilt-2-0-0.md b/...ct-model-SingleLevelBomAsBuilt-2_0_0/#212-Update-SingleLevelBomAsBuilt-2-0-0.md
@@ -2,7 +2,7 @@
 
 # Problem Statement
 
-SingleLevelBomAsBuilt 2.0.0 introduces a new boolean property `hasAlternatives`.
+[SingleLevelBomAsBuilt 2.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_built/2.0.0) introduces a new boolean property `hasAlternatives`.
 The model now allows to reference items that are not available as AsBuilt Twins - (e.g. Serial items or batches) but as AsPlanned twins.
 Sometimes, however, it is not known what exact AsPlanned twin is needed to build the BoM asBuilt because there are different alternative twins to choose from.
 In that case, all potential alternatives have to be referenced. To indicate that ambiguity, the property "hasAlternative" has been added to the aspect model.

diff --git a/docs/src/docs/arc42/glossary.adoc b/docs/src/docs/arc42/glossary.adoc
@@ -35,6 +35,6 @@ https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/
 |Shell | | see "Asset Administration Shell"
 |Traversal Aspect | | aka Edge: Aspect which the IRS uses for traversal through the data chain. Identified by a parent-child or a child-parent relationship.
 
-Samples: SingleLevelBomAsPlanned, SingleLevelBomAsBuilt and SingleLevelUsageAsBuilt
+Samples: https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_planned[SingleLevelBomAsPlanned], https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_built[SingleLevelBomAsBuilt] and https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_usage_as_built[SingleLevelUsageAsBuilt]
 |Verifiable Credential | VC | For more information see: https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2/3.%20Verifiable%20Credentials[Verifiable Credentials]
 |===
diff --git a/docs/src/docs/arc42/introduction-goals/requirements.adoc b/docs/src/docs/arc42/introduction-goals/requirements.adoc
@@ -9,7 +9,7 @@ The IRS is a:
 - Data chain provider
 
 == Substantial Features
-- provide a top-down BoM asBuilt tree structure along the submodel "SingleLevelBomAsBuilt"
+- provide a top-down BoM asBuilt tree structure along the submodel https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_built["SingleLevelBomAsBuilt"]
 - usage of EDC consumer for communicating with the Catena-X network
 - functionality of IRS provider will be handled by providers submodel servers
 - federated IRS service

diff --git a/docs/src/docs/arc42/runtime-view/irs-iterative/scenario-2.adoc b/docs/src/docs/arc42/runtime-view/irs-iterative/scenario-2.adoc
@@ -12,7 +12,7 @@ include::../../../../uml-diagrams/runtime-view/job-execution.puml[]
 
 After a job has been created (see Scenario 1: Create Job), the first transfer containing the root item ID is passed to the ExecutorService. The transfer is then started asynchronously and retrieves the necessary information from the Catena-X network, first by fetching the AAS information from the DigitalTwin registry and then calling the SubmodelProviders for the submodel payload.
 
-At least the aspect SingleLevelBomAsBuilt is required for the tree to be built. If the customer that started the job provided more aspects to be fetched, they will be retrieved here too.
+At least the aspect https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_built[SingleLevelBomAsBuilt] is required for the tree to be built. If the customer that started the job provided more aspects to be fetched, they will be retrieved here too.
 The result of each transfer is stored in the BlobStore.
 
 After the transfer process has finished, any subsequent child IDs will be extracted and new transfer processes will be scheduled for those via the ExecutorService. This cycle repeats until all leafs were reached, the specified max depth has been reached, or the job was canceled externally.

diff --git a/docs/src/docs/arc42/scope-context/technical-context.adoc b/docs/src/docs/arc42/scope-context/technical-context.adoc
@@ -13,7 +13,7 @@ We provide a REST API that can be consumed by any system registered in the Caten
 In order to consume the Restful application IRS, the security aspect should be taken in consideration. IRS is a Spring Boot based application and is secured with the OpenID connector provider with OAuth2 protocol. This means for the consumers (users) that they need to authenticate themselves in order to be authorized to get access to the IRS. They generate a bearer token that they get from OAuth2 provider and attach it to the HTTP header parameter Authorization.
 
 === Registry API
-The IRS acts as a consumer of the component Asset Administration Shell Registry. The IRS contains a Restful client (REST template) that build a REST call to the mentioned Digital Twin Registry API based on its known URL (the AAS registry URL is configured in the IRS Restful API). The request contains the given "globalAssetId" by the consumer. Like described in the above section, the security aspect is required in order to achieve a REST call against the AAS Registry. As a response, the IRS gets the corresponding asset administration shell descriptor. The last one contains a list of submodel descriptors which can be filtered by the aspect type entered by the consumer. An aspect type like SingleLevelBomAsBuilt, SerialPart etc. And as mentioned above, the transport protocol HTTP(S) is used for the REST call communication.
+The IRS acts as a consumer of the component Asset Administration Shell Registry. The IRS contains a Restful client (REST template) that build a REST call to the mentioned Digital Twin Registry API based on its known URL (the AAS registry URL is configured in the IRS Restful API). The request contains the given "globalAssetId" by the consumer. Like described in the above section, the security aspect is required in order to achieve a REST call against the AAS Registry. As a response, the IRS gets the corresponding asset administration shell descriptor. The last one contains a list of submodel descriptors which can be filtered by the aspect type entered by the consumer. An aspect type like https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_built[SingleLevelBomAsBuilt], https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.serial_part[SerialPart] etc. And as mentioned above, the transport protocol HTTP(S) is used for the REST call communication.
 
 ==== Discovery Service
 In a decentralized system, the digital twin registry is moved behind an EDC. To access the registry of a data provider, a new set of central services was introduces. These discovery services consist of BPN Discovery, Discovery Finder and EDC Discovery.