Skip to content

Commit

Permalink
editorial changes (#361)
Browse files Browse the repository at this point in the history
* added xref
correct GetDescription to GetSelfDescription
renamed id to ID
Clause 4.5 substitutet with ref. to AASd-116

* add more xref:

* remove deprecated reference to Plattform I4.0
corrected some links
do not reference Glossary Plattform I4.0 directly only via Terms and Definitions

* added puml to partials, directly link puml, not .png
  • Loading branch information
BirgitBoss authored Jan 2, 2025
1 parent 48665f9 commit 98a9aea
Show file tree
Hide file tree
Showing 3 changed files with 254 additions and 122 deletions.
19 changes: 11 additions & 8 deletions documentation/IDTA-01002-3/modules/ROOT/pages/general.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ However, to avoid terminological and conceptual misunderstandings, the whole Ind

The technology-neutral level comprises the following concepts:

* *Service*: a service describes a demarcated scope of functionality (including its informational and non-functional aspects), which is offered by an entity or organization via https://www.plattform-i40.de/PI40/Redaktion/EN/Glossary/I/interface_glossary.html[interfaces].
* *Service*: a service describes a demarcated scope of functionality (including its informational and non-functional aspects), which is offered by an entity or organization via interfaces.
* *Interface*: this is the most important concept as it is understood to be the unit of reusability across services and the unit of standardization when mapped to application programming interfaces (API) in the technology-specific level.
One interface may be mapped to several APIs depending on the technology and architectural style used, e.g. HTTP/REST or OPC UA, whereby these API mappings also need to be standardized for the sake of interoperability.
* *Interface-Operation*: interface operations define interaction patterns via the specified interface.
Expand Down Expand Up @@ -155,8 +155,8 @@ The identifiers defined in this document are reused in related resources, for in

Internationalized Resource Identifiers (IRIs), Uniform Resource Identifiers (URIs) xref:bibliography.adoc#bib5[[5\]] in particular, and the requirements of DIN SPEC 91406 xref:bibliography.adoc#bib6[[6\]], serve as the basic format.
Further design decisions include ‘https’ as the URI scheme, and the controlled domain name ‘admin-shell.io’ as the chosen authority.
Both decisions guarantee the interoperability of the identifiers and their durability, since URIs are generally well-known and proven, while the domain is controlled and served through the Plattform Industrie 4.0.
All identifiers included in the ‘admin-shell.io’ domain are described in a lightweight catalogue in the form of Markdown documents; they are continuously maintained and updated [https://github.com/admin-shell-io/id].
Both decisions guarantee the interoperability of the identifiers and their durability, since URIs are generally well-known and proven, while the domain is controlled and served through the Industrial Digital Twin Association (IDTA).
All identifiers included in the ‘admin-shell.io’ domain are described in a lightweight catalogue in the form of Markdown documents; they are continuously maintained and updated link:https://github.com/admin-shell-io/id[https://github.com/admin-shell-io/id].
The catalogue itself is structured in several sub-namespaces specified by the first path parameter.
All URIs of this document reflect entities of the core metamodel, which are contained in the sub-namespace identified with the ‘/aas/API’ path.

Expand Down Expand Up @@ -279,7 +279,8 @@ The separate interfaces of the HTTP/REST API allow many ways to support differen

For an AAS repository, the combination [.gray]#“Asset Administration Shell Repository Interface”#, [.red]#“Asset Administration Shell Interface”#, [.blue]#“Submodel Interface”#, “Serialization Interface”, and “Self-Description Interface” is proposed.

This will result in the following HTTP/REST paths as described in a combined OpenAPI file (https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRepositoryServiceSpecification/V3.1_SSP-001)[For easier reading only the standard paths are shown in the following: $metadata, $value, $reference and $path parameter paths are additionally contained in the OpenAPI file.]:
This will result in the following HTTP/REST paths as described in a combined OpenAPI file link:https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRepositoryServiceSpecification/V3.1_SSP-001[AssetAdministrationShellRepositoryServiceSpecification/V3.1_SSP-001].footnote[
For easier reading only the standard paths are shown in the following: $metadata, $value, $reference and $path parameter paths are additionally contained in the OpenAPI file.]:

[.gray]#/shells# +
[.gray]#/shells/\{aas-identifier}# +
Expand All @@ -300,7 +301,8 @@ This will result in the following HTTP/REST paths as described in a combined Ope

If the repository also supports AASX Packages, it shall be extended by additionally supporting a “AASX File Server” Profile [Related OpenAPI file: https://app.swaggerhub.com/apis/Plattform_i40/AasxFileServerServiceSpecification/V3.1_SSP-001].

The example of a device or container containing one AAS with its related submodels will result in the following HTTP/REST paths as described in the related OpenAPI file (https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellServiceSpecification/V3.1_SSP-001)^2^:
The example of a device or container containing one AAS with its related submodels will result in the following HTTP/REST paths as described in the related OpenAPI file (https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellServiceSpecification/V3.1_SSP-001)footnote[Related OpenAPI file: link:https://app.swaggerhub.com/apis/Plattform_i40/AasxFileServerServiceSpecification/V3.0_SSP-001[AasxFileServerServiceSpecification/V3.0_SSP-001]
]:

[.red]#/aas# +
[.red]#/aas/asset-information# +
Expand Down Expand Up @@ -342,10 +344,11 @@ TechnicalData has its major variable part on the bottom and a small fixed struct
HandoverDocumentation consists basically of a list of document information according VDI 2770 (DocumentedEntity{00}). It is expected, that this will be changed to SubmodelElementList like other V3 Submodels. An example is to search for Documents of a certain ClassId (semanticId = 0173-1#02-ABH996#001, ClassId = "03-01", i.e. Commissioning) in a certain language (semanticId = 0173-1#02-AAN468#006, e.g. Value = "nl").



.Main elements of the AAS Query Language
image::../images/plantuml/query-language-overview.png[]

[plantuml, 29-relationship-element, svg]
....
include::partial$diagrams/query-language-overview.puml[]
....

=== Limitations

Expand Down
Loading

0 comments on commit 98a9aea

Please sign in to comment.