Skip to content

Commit ac2a09c

Browse files
authored
subprotocolBody has length 2048 according to spec (#460)
* subprotocolBody has length 2048 according to spec * update changelog table * Revert "update changelog table" This reverts commit 2800f50. * fix length contenttype from 100 to 128 * fix inconsistency between swagger and text spec by changing LabelType to NameType
1 parent b99f510 commit ac2a09c

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

Part2-API-Schemas/openapi.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ components:
252252
contentType:
253253
type: string
254254
minLength: 1
255-
maxLength: 100
255+
maxLength: 128
256256
value:
257257
type: string
258258
minLength: 1
@@ -332,7 +332,7 @@ components:
332332
contentType:
333333
type: string
334334
minLength: 1
335-
maxLength: 100
335+
maxLength: 128
336336
value:
337337
type: string
338338
minLength: 1

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Major Changes:
3434
* OpenAPI: marked parameter 'level' as deprecated for all URLs ending with '/$reference'
3535
* change: ProtocolInformation/securityAttributes changed from mandatory to optional.
3636
* change: Endpoint/interface extended with "VALUE" and "METADATA" aspects.
37+
* change: data type for ProtocolInformation/endpointProtocolVersion and subprotocolBodyEncoding changed from LabelType to NameType
3738
* new: Added 'Role' and 'NotApplicable' wherever AssetAdministrationShellDescriptor/AssetKind is used.
3839
* 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]
3940
* change: Fix missing 'Repository' in ConceptDescriptionServiceSpecification to ConceptDescriptionRepositoryServiceSpecification (https://github.com/admin-shell-io/aas-specs-api/issues/171[#171])
@@ -167,7 +168,6 @@ added new API-operation SearchAllAssetAdministrationShellIdsByAssetLink
167168

168169
| | xref:specification/interfaces-payload.adoc#AssetAdministrationShellDescriptor[AssetAdministrationShellDescriptor/globalAssetId] a| data type: change length from 2000 to 2048 characters
169170

170-
171171
| | xref:specification/interfaces-payload.adoc#AssetAdministrationShellDescriptor[AssetAdministrationShellDescriptor/id] a| data type: change length from 2000 to 2048 characters
172172

173173
| | xref:specification/interfaces-payload.adoc#SubmodelDescriptor[SubmodelDescriptor/id] a| data type: change length from 2000 to 2048 characters
@@ -176,6 +176,10 @@ added new API-operation SearchAllAssetAdministrationShellIdsByAssetLink
176176

177177
| | xref:specification/interfaces-payload.adoc#ProtocolInformation[ProtocolInformation/href] a| data type: change length from 2000 to 2048 characters
178178

179+
| | 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)
180+
181+
| | 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)
182+
179183
| | 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])
180184
|===
181185

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,13 +201,13 @@ e|href |The endpoint address as a URL |xref:LocatorType[LocatorType] |1
201201

202202
e|endpointProtocol |Either scheme of endpointAddress or scheme + further information. Scheme denotes the highest level of doubtless transmission. |xref:SchemeType[SchemeType] |0..1
203203

204-
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..*
204+
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..*
205205

206206
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
207207

208208
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
209209

210-
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
210+
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
211211

212212
e|securityAttributes a|
213213
Array of securityAttribute objects, each attribute has 3 properties:

0 commit comments

Comments
 (0)