From ee6187cbb2f15b75c0d983866dd43c6ddb121269 Mon Sep 17 00:00:00 2001 From: Birgit Boss Date: Fri, 23 May 2025 15:57:40 +0200 Subject: [PATCH 1/5] subprotocolBody has length 2048 according to spec --- Part2-API-Schemas/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Part2-API-Schemas/openapi.yaml b/Part2-API-Schemas/openapi.yaml index afb4e88..6381085 100644 --- a/Part2-API-Schemas/openapi.yaml +++ b/Part2-API-Schemas/openapi.yaml @@ -746,7 +746,7 @@ components: maxLength: 128 subprotocolBody: type: string - maxLength: 128 + maxLength: 2048 subprotocolBodyEncoding: type: string maxLength: 128 From 2800f508f8c487b0f397e1b16eb6b7347d9cb512 Mon Sep 17 00:00:00 2001 From: Birgit Boss Date: Fri, 23 May 2025 16:01:10 +0200 Subject: [PATCH 2/5] update changelog table --- documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc index c09bb02..d452f5c 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc @@ -154,6 +154,8 @@ added new API-operation SearchAllAssetAdministrationShellIdsByAssetLink | | xref:http-rest-api/http-rest-api.adoc#PackageDescription[PackageDescription/aasIds] a| data type: change length from 2000 to 2048 characters +| | xref:specification/interfaces-payload.adoc#ProtocolInformation[ProtocolInformation/subprotocolBody] a| data type: change length from 128 to 2048 characters + | | xref:specification/interfaces-payload.adoc#ProtocolInformation[ProtocolInformation/href] a| data type: change length from 2000 to 2048 characters | | xref:specification/interfaces-payload.adoc#ProtocolInformation[ProtocolInformation/securityAttributes] a| Changed securityAttributes from `mandatory` to `optional`. OpenAPI remains unchanged. (https://github.com/admin-shell-io/aas-specs-api/issues/384[#384]) From 9dd9328c32a4f2e112ab2ce219e78dac55b38b46 Mon Sep 17 00:00:00 2001 From: Birgit Boss Date: Fri, 23 May 2025 16:26:53 +0200 Subject: [PATCH 3/5] Revert "update changelog table" This reverts commit 2800f508f8c487b0f397e1b16eb6b7347d9cb512. --- documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc index d452f5c..c09bb02 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc @@ -154,8 +154,6 @@ added new API-operation SearchAllAssetAdministrationShellIdsByAssetLink | | xref:http-rest-api/http-rest-api.adoc#PackageDescription[PackageDescription/aasIds] a| data type: change length from 2000 to 2048 characters -| | xref:specification/interfaces-payload.adoc#ProtocolInformation[ProtocolInformation/subprotocolBody] a| data type: change length from 128 to 2048 characters - | | xref:specification/interfaces-payload.adoc#ProtocolInformation[ProtocolInformation/href] a| data type: change length from 2000 to 2048 characters | | xref:specification/interfaces-payload.adoc#ProtocolInformation[ProtocolInformation/securityAttributes] a| Changed securityAttributes from `mandatory` to `optional`. OpenAPI remains unchanged. (https://github.com/admin-shell-io/aas-specs-api/issues/384[#384]) From 6d06d4615888138adeaa907486dec9b98fca7be3 Mon Sep 17 00:00:00 2001 From: Birgit Boss Date: Fri, 23 May 2025 16:44:50 +0200 Subject: [PATCH 4/5] fix length contenttype from 100 to 128 --- Part2-API-Schemas/openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Part2-API-Schemas/openapi.yaml b/Part2-API-Schemas/openapi.yaml index 6381085..8a11c94 100644 --- a/Part2-API-Schemas/openapi.yaml +++ b/Part2-API-Schemas/openapi.yaml @@ -252,7 +252,7 @@ components: contentType: type: string minLength: 1 - maxLength: 100 + maxLength: 128 value: type: string minLength: 1 @@ -332,7 +332,7 @@ components: contentType: type: string minLength: 1 - maxLength: 100 + maxLength: 128 value: type: string minLength: 1 From b7be789e8f27cb488806b53534389f4a7040d23c Mon Sep 17 00:00:00 2001 From: Birgit Boss Date: Fri, 23 May 2025 16:51:45 +0200 Subject: [PATCH 5/5] fix inconsistency between swagger and text spec by changing LabelType to NameType --- .../IDTA-01002-3/modules/ROOT/pages/changelog.adoc | 6 +++++- .../ROOT/pages/specification/interfaces-payload.adoc | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc index c09bb02..d14f97e 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc @@ -34,6 +34,7 @@ Major Changes: * OpenAPI: marked parameter 'level' as deprecated for all URLs ending with '/$reference' * change: ProtocolInformation/securityAttributes changed from mandatory to optional. * change: Endpoint/interface extended with "VALUE" and "METADATA" aspects. +* change: data type for ProtocolInformation/endpointProtocolVersion and subprotocolBodyEncoding changed from LabelType to NameType * new: Added 'Role' and 'NotApplicable' wherever AssetAdministrationShellDescriptor/AssetKind is used. * change: Added minLength=1 requirement and regex pattern "^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9_]+$" to all classes with idShort parameters to keep definitions in sync with the declaration of link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/common.html#referable-attributes[Referable/idShort] * change: Fix missing 'Repository' in ConceptDescriptionServiceSpecification to ConceptDescriptionRepositoryServiceSpecification (https://github.com/admin-shell-io/aas-specs-api/issues/171[#171]) @@ -147,7 +148,6 @@ added new API-operation SearchAllAssetAdministrationShellIdsByAssetLink | | xref:specification/interfaces-payload.adoc#AssetAdministrationShellDescriptor[AssetAdministrationShellDescriptor/globalAssetId] a| data type: change length from 2000 to 2048 characters - | | xref:specification/interfaces-payload.adoc#AssetAdministrationShellDescriptor[AssetAdministrationShellDescriptor/id] a| data type: change length from 2000 to 2048 characters | | xref:specification/interfaces-payload.adoc#SubmodelDescriptor[SubmodelDescriptor/id] a| data type: change length from 2000 to 2048 characters @@ -156,6 +156,10 @@ added new API-operation SearchAllAssetAdministrationShellIdsByAssetLink | | xref:specification/interfaces-payload.adoc#ProtocolInformation[ProtocolInformation/href] a| data type: change length from 2000 to 2048 characters +| | xref:specification/interfaces-payload.adoc#ProtocolInformation[ProtocolInformation/endpointProtocolVersion] a| data type: change from LabelType to NameType (i.e.g change of length from 64 to 128 characters) + +| | xref:specification/interfaces-payload.adoc#ProtocolInformation[ProtocolInformation/subprotocolBodyEncoding] a| data type: change from LabelType to NameType (i.e.g change of length from 64 to 128 characters) + | | xref:specification/interfaces-payload.adoc#ProtocolInformation[ProtocolInformation/securityAttributes] a| Changed securityAttributes from `mandatory` to `optional`. OpenAPI remains unchanged. (https://github.com/admin-shell-io/aas-specs-api/issues/384[#384]) |=== diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc index a385a1d..2e64d45 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc @@ -201,13 +201,13 @@ e|href |The endpoint address as a URL |xref:LocatorType[LocatorType] |1 e|endpointProtocol |Either scheme of endpointAddress or scheme + further information. Scheme denotes the highest level of doubtless transmission. |xref:SchemeType[SchemeType] |0..1 -e|endpointProtocolVersion |Array of strings, each entry represents one supported version at this very endpoint, the entry shall be formatted according to the regulations of the protocol specified in the href |link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/datatypes.html#LabelType[LabelType] |0..* +e|endpointProtocolVersion |Array of strings, each entry represents one supported version at this very endpoint, the entry shall be formatted according to the regulations of the protocol specified in the href |link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/datatypes.html#NameType[NameType] |0..* e|subprotocol |Allows for referencing sub-protocols that may be used in the context of that endpoint e.g. “OPC Basic SOAP” or UA Binary |xref:ShortIdType[ShortIdType] |0..1 e|subprotocolBody |If the sub-protocol field is present, a subprotocolBody might be given to hold extra information, e.g. node and namespace in an OPC UA server |xref:TextType[TextType] |0..1 -e|subprotocolBodyEncoding |If subprotocolBody is present, the encoding might be explicitly defined, otherwise it shall default to subprotocols encoding scheme |link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/datatypes.html#LabelType[LabelType] |0..1 +e|subprotocolBodyEncoding |If subprotocolBody is present, the encoding might be explicitly defined, otherwise it shall default to subprotocols encoding scheme |link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/datatypes.html#NameType[NameType] |0..1 e|securityAttributes a| Array of securityAttribute objects, each attribute has 3 properties: