Skip to content

Bi bo/editorial changes 3 2 #498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: IDTA-01002-3-2_Working
Choose a base branch
from
Open

Bi bo/editorial changes 3 2 #498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c8a63b5
add link to GetFileByPath
BirgitBoss Oct 19, 2025
7701472
SerializationFormat: remove mentioning of AML, RDF because not (yet c…
BirgitBoss Oct 19, 2025
0143f93
formatting of table for Submodel Interface
BirgitBoss Oct 19, 2025
1c5bceb
correct link .adoc instead of html
BirgitBoss Oct 19, 2025
833a941
correct formatting of constraint AASa-003 + update links to V3-1 for …
BirgitBoss Oct 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ...002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
8 changes: 4 additions & 4 deletions documentation/IDTA-01002-3/modules/ROOT/pages/includes/constraints.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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].]
6 changes: 4 additions & 2 deletions documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion documentation/IDTA-01002-3/modules/ROOT/pages/summary-and-outlook.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.