Skip to content

Commit 07bc78a

Browse files
Include Note for the Operation GenerateSerializationByIds (#512)
* add note for the operation GenerateSerializationByIds * Update documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc Co-authored-by: Birgit Boss <[email protected]> --------- Co-authored-by: Birgit Boss <[email protected]>
1 parent 720463d commit 07bc78a

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ Major Changes:
1919

2020
Minor Changes:
2121

22-
* ...
2322
* Added the `ServerNotImplemented` status code to the xref:specification/interfaces-payload.adoc#table-status-codes[Status Codes]. Note that the HTTP API mentioned this status code already, therefore, no change in OpenAPI or other related files. (https://github.com/admin-shell-io/aas-specs-api/issues/499[#499])
2423

2524

@@ -29,9 +28,8 @@ Minor Changes:
2928
[%autowidth,width="100%",cols="40%,15%,45%",options="header",]
3029
|===
3130
h|Operation h|Kind of Change h|Comment
32-
31+
| GenerateSerializationByIds|change a| Added a note to clarify the intended behavior for transitively referenced concept descriptions. (https://github.com/admin-shell-io/aas-specs-api/issues/510[#510])
3332
| PutAssetAdministrationShellById|change a| Added the missing `id` input parameter and a note explaining the behavior in case the AAS identifier does not match the value of `id`. (https://github.com/admin-shell-io/aas-specs-api/issues/506[#506])
34-
3533
|===
3634

3735

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,12 @@ h|Name h|Description h|Mand. h|Type h|Card.
654654
5+h|Input Parameter
655655
|aasIds |The unique ids of the Asset Administration Shells to be contained in the serialization |no |link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/datatypes.html#Identifier[Identifier] |1..*
656656
|submodelIds |The unique ids of the Submodels to be contained in the serialization |no |link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/datatypes.html#Identifier[Identifier] |1..*
657-
|includeConceptDescriptions a|Include all concept descriptions that are referenced in the Submodels contained in the serialization and that are known to the server |no |boolean |1
657+
|includeConceptDescriptions a|Include all concept descriptions that are referenced in the Submodels contained in the serialization and that are known to the server
658+
====
659+
Note: This shall also include the concept descriptions that are indirectly referenced by a Submodel, e.g., via the `valueList` attribute from the IEC 63260 data specification template.
660+
====
661+
662+
|no |boolean |1
658663
|serializationFormat |Denotes in which serialization format the requested content shall be delivered |no |xref:specification/interfaces.adoc#SerializationFormat[SerializationFormat] |1
659664
5+h|Output Parameter
660665
|statusCode |Status code |yes |xref:specification/interfaces-payload.adoc#StatusCode[StatusCode] |1

0 commit comments

Comments
 (0)