From c8a63b5b06474d67ac63aa2c92f1c37b5408ed3f Mon Sep 17 00:00:00 2001 From: Birgit Boss Date: Sun, 19 Oct 2025 21:00:17 +0200 Subject: [PATCH 1/5] add link to GetFileByPath --- .../http-rest-api/service-specifications-and-profiles.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc index 15b8fb03..1e94c0f2 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc @@ -911,7 +911,7 @@ __Submodel API by superpath:__ + xref:specification/interfaces.adoc#GetSubmodel[GetSubmodel] + xref:specification/interfaces.adoc#GetAllSubmodelElements[GetAllSubmodelElements] + xref:specification/interfaces.adoc#GetSubmodelElementByPath[GetSubmodelElementByPath] + -GetFileByPath +xref:specification/interfaces.adoc#GetFileByPath[GetFileByPath] _Serialization API:_ + xref:specification/interfaces.adoc#GenerateSerializationByIds[GenerateSerializationByIds] From 770147243358af78948db299cd4b54482d856d44 Mon Sep 17 00:00:00 2001 From: Birgit Boss Date: Sun, 19 Oct 2025 21:09:25 +0200 Subject: [PATCH 2/5] SerializationFormat: remove mentioning of AML, RDF because not (yet contained) + outlook that enum may be extended in future releases --- .../modules/ROOT/pages/specification/interfaces.adoc | 4 +++- .../IDTA-01002-3/modules/ROOT/pages/summary-and-outlook.adoc | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc index 9d47ede8..da5867ea 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc @@ -666,7 +666,9 @@ h|Name h|Description h|Mand. h|Type h|Card. |=== h|Enumeration: e|[[SerializationFormat]]SerializationFormat -h|Explanation: a|Determines the format of serialization, i.e. JSON, XML, RDF, AML, etc.RFC 6838, IANA Media Types, and defined custom content types; additional elements may be added in future versions +h|Explanation: a|Determines the format of serialization, for example JSON or XML. + +The values are media types conformant to RFC 2046 and registered as described in RFC 6838 (IANA). h|Set of: |-- h|Literal h|Explanation e|application/json a|JSON serialization of the requested data object inside an AAS Environment structure diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/summary-and-outlook.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/summary-and-outlook.adoc index a1f4ecdd..f2750d94 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/summary-and-outlook.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/summary-and-outlook.adoc @@ -19,5 +19,5 @@ In this version of the specification, HTTP/REST APIs are defined and mapped to t In subsequent versions of this specification, APIs using other technologies are planned to be supported, e.g. gRPC or MQTT. -Additionally, further interfaces, service specifications, and profiles may be defined. +Additionally, further interfaces, service specifications, serialization formats for the API-operation "GenerateSerializationByIds" and profiles may be defined. From 0143f93c354390cdef33cffe850d9a318d0bf6c6 Mon Sep 17 00:00:00 2001 From: Birgit Boss Date: Sun, 19 Oct 2025 21:13:54 +0200 Subject: [PATCH 3/5] formatting of table for Submodel Interface --- .../modules/ROOT/pages/specification/interfaces.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc index da5867ea..c3c35fab 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc @@ -222,7 +222,7 @@ e|statusCode a|Status code |yes |xref:specification/interfaces-payload.adoc#Stat ==== Submodel Interface -[%autowidth,width="100%",options="header",] +[width=100%,cols="25%,75%"] |=== 2+h|Interface: [[interface-Submodel]]_Submodel_ h|Operation Name h|Description From 1c5bceb6397228b7d61da25067f953b1266e3f45 Mon Sep 17 00:00:00 2001 From: Birgit Boss Date: Sun, 19 Oct 2025 21:15:29 +0200 Subject: [PATCH 4/5] correct link .adoc instead of html --- documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc index 1fd4bc2b..83a358b0 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc @@ -53,7 +53,7 @@ Minor Changes: * xref:http-rest-api/http-rest-api.adoc#design-decisions[Design Decisions for the HTTP API]: Clarify that padding is not allowed for base64url-encoded values (https://github.com/admin-shell-io/aas-specs-api/issues/423[#423]) * xref:http-rest-api/http-rest-api.adoc#modifier-constraints[HTTP Modifier Constraints]: adding note for metadata and value-only representations of Asset Administration Shells (https://github.com/admin-shell-io/aas-specs-api/issues/268[#268]) * xref:http-rest-api/interactions.adoc[Interactions]: extending the explanation how to discover endpoints of AAS services -* xref:http-rest-api/http-rest-api.html#_mapping_of_operations[Mapping of Operations]: adding missing path for the row defining the mapping of PutAssetAdministrationShell to HTTP +* xref:http-rest-api/http-rest-api.adoc#_mapping_of_operations[Mapping of Operations]: adding missing path for the row defining the mapping of PutAssetAdministrationShell to HTTP * Fixing several "operationId" and "x-semanticIds" values in OpenAPI files. === Interface Changes w.r.t. V3.0.4 to V3.1 From 833a941ad304ee20527d51bfa323a14f4283f8a1 Mon Sep 17 00:00:00 2001 From: Birgit Boss Date: Sun, 19 Oct 2025 21:23:36 +0200 Subject: [PATCH 5/5] correct formatting of constraint AASa-003 + update links to V3-1 for Part 1 and 2 --- .../modules/ROOT/pages/includes/constraints.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/includes/constraints.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/includes/constraints.adoc index 997b7781..cf014eca 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/includes/constraints.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/includes/constraints.adoc @@ -12,10 +12,10 @@ SPDX-License-Identifier: CC-BY-4.0 :aasa001: pass:q[[underline]#Constraint AASa-001:# The value of the xref:http-rest-api/http-rest-api.adoc#pagination[cursor] query parameter must not be empty. If the client does not know the cursor value, it must omit the whole query parameter in the request.] -:aasa002: pass:q[[underline]#Constraint AASa-002#: The base64url-encoded identifier of the link: https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/common.html#has-semantics-attributes[semanticId] shall have a length of maximum 3072 characters.] +:aasa002: pass:q[[underline]#Constraint AASa-002#: The base64url-encoded identifier of the link: https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/V3.2/spec-metamodel/common.html#has-semantics-attributes[semanticId] shall have a length of maximum 3072 characters.] -:aasa003: pass:q[[underline]#Constraint AASa-003#: A service implementing the link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.1/http-rest-api/service-specifications-and-profiles.html#submodel-repositoryservice-specification-SSP-003[SubmodelRepositoryServiceSpecification/SSP-003] must not accept or provide any _Submodel_ with the attribute link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/common.html#ModellingKind[kind="Instance"]. +:aasa003: pass:q[[underline]#Constraint AASa-003#: A service implementing the link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/V3.2/http-rest-api/service-specifications-and-profiles.html#submodel-repositoryservice-specification-SSP-003[SubmodelRepositoryServiceSpecification/SSP-003] must not accept or provide any link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/V3.2/spec-metamodel/core.html#submodel-attributes[Submodel] with the attribute link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/V3.2/spec-metamodel/common.html#ModellingKind[kind="Instance"].] -:aasa004: pass:q[[underline]#Constraint AASa-004#: A service implementing the link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.1/http-rest-api/service-specifications-and-profiles.html#_submodel_repository_template_read_profile[SubmodelRepositoryServiceSpecification/SSP-004] must not accept or provide any _Submodel_ with the attribute link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/common.html#ModellingKind[kind="Instance"].] +:aasa004: pass:q[[underline]#Constraint AASa-004#: A service implementing the link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/V3.2/http-rest-api/service-specifications-and-profiles.html#_submodel_repository_template_read_profile[SubmodelRepositoryServiceSpecification/SSP-004] must not accept or provide any _Submodel_ with the attribute link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/V3.2/spec-metamodel/common.html#ModellingKind[kind="Instance"].] -:aasa005: pass:q[[underline]#Constraint AASa-005:# Only the _SubmodelElements_ root delaration can be followed with link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/mappings/mappings.html#_format_path_idshortpath_serialization_in_json[IdShortPaths].] +:aasa005: pass:q[[underline]#Constraint AASa-005:# Only the _SubmodelElements_ root delaration can be followed with link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/V3.2/mappings/mappings.html#_format_path_idshortpath_serialization_in_json[IdShortPaths].]