Skip to content

subprotocolBody has length 2048 according to spec #460

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.

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

Merged
merged 5 commits into from
May 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions Part2-API-Schemas/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ components:
contentType:
type: string
minLength: 1
maxLength: 100
maxLength: 128
value:
type: string
minLength: 1
Expand Down Expand Up @@ -332,7 +332,7 @@ components:
contentType:
type: string
minLength: 1
maxLength: 100
maxLength: 128
value:
type: string
minLength: 1
Expand Down Expand Up @@ -746,7 +746,7 @@ components:
maxLength: 128
subprotocolBody:
type: string
maxLength: 128
maxLength: 2048
subprotocolBodyEncoding:
type: string
maxLength: 128
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
* 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

Check warning on line 37 in documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc

View workflow job for this annotation

GitHub Actions / qodana

Typo

Typo: In word 'subprotocol'
* 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])
Expand Down Expand Up @@ -147,7 +148,6 @@

| | 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
Expand All @@ -156,6 +156,10 @@

| | 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)

Check warning on line 161 in documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc

View workflow job for this annotation

GitHub Actions / qodana

Typo

Typo: In word 'subprotocol'

| | 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])
|===

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down