Skip to content

Commit 3b7c559

Browse files
authored
Merge branch 'IDTA-01002-3-2_Working' into IDTA-01002-3-2_working
2 parents 6f0df40 + 8835585 commit 3b7c559

File tree

6 files changed

+14
-10
lines changed

6 files changed

+14
-10
lines changed
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
name: IDTA-01002
22
title: 'Part 2: API'
3-
version: 'v3.1.1'
3+
version: 'v3.2'
4+
display_version: 'in progress'
5+
prerelease: true
46
start_page: ROOT:index.adoc
57
nav:
68
- modules/ROOT/nav.adoc

documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Minor Changes:
109109
* 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])
110110
* 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])
111111
* xref:http-rest-api/interactions.adoc[Interactions]: extending the explanation how to discover endpoints of AAS services
112-
* 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
112+
* 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
113113
* Fixing several "operationId" and "x-semanticIds" values in OpenAPI files.
114114

115115
=== Interface Changes w.r.t. V3.0.4 to V3.1

documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -911,7 +911,7 @@ __Submodel API by superpath:__ +
911911
xref:specification/interfaces.adoc#GetSubmodel[GetSubmodel] +
912912
xref:specification/interfaces.adoc#GetAllSubmodelElements[GetAllSubmodelElements] +
913913
xref:specification/interfaces.adoc#GetSubmodelElementByPath[GetSubmodelElementByPath] +
914-
GetFileByPath
914+
xref:specification/interfaces.adoc#GetFileByPath[GetFileByPath]
915915

916916
_Serialization API:_ +
917917
xref:specification/interfaces.adoc#GenerateSerializationByIds[GenerateSerializationByIds]

documentation/IDTA-01002-3/modules/ROOT/pages/includes/constraints.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ SPDX-License-Identifier: CC-BY-4.0
1212

1313
: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.]
1414

15-
: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.]
15+
: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.]
1616

17-
: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"].
17+
: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"].]
1818

19-
: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"].]
19+
: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"].]
2020

21-
: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].]
21+
: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].]

documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ e|statusCode a|Status code |yes |xref:specification/interfaces-payload.adoc#Stat
222222

223223
==== Submodel Interface
224224

225-
[%autowidth,width="100%",options="header",]
225+
[width=100%,cols="25%,75%"]
226226
|===
227227
2+h|Interface: [[interface-Submodel]]_Submodel_
228228
h|Operation Name h|Description
@@ -666,7 +666,9 @@ h|Name h|Description h|Mand. h|Type h|Card.
666666
|===
667667

668668
h|Enumeration: e|[[SerializationFormat]]SerializationFormat
669-
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
669+
h|Explanation: a|Determines the format of serialization, for example JSON or XML.
670+
671+
The values are media types conformant to RFC 2046 and registered as described in RFC 6838 (IANA).
670672
h|Set of: |--
671673
h|Literal h|Explanation
672674
e|application/json a|JSON serialization of the requested data object inside an AAS Environment structure

documentation/IDTA-01002-3/modules/ROOT/pages/summary-and-outlook.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ In this version of the specification, HTTP/REST APIs are defined and mapped to t
1919

2020
In subsequent versions of this specification, APIs using other technologies are planned to be supported, e.g. gRPC or MQTT.
2121

22-
Additionally, further interfaces, service specifications, and profiles may be defined.
22+
Additionally, further interfaces, service specifications, serialization formats for the API-operation "GenerateSerializationByIds" and profiles may be defined.
2323

0 commit comments

Comments
 (0)