View Issue Details

IDProjectCategoryView StatusLast Update
000978910000-006: MappingsSpecpublic2024-09-09 07:49
ReporterMatthias Damm Assigned ToRandy Armstrong  
PriorityhighSeveritymajorReproducibilityhave not tried
Status assignedResolutionopen 
Product Version1.05.04 RC1 
Target Version1.05.04 
Summary0009789: Remove outer object of OpenAPI Request/Reponse Message
Description

Unified Automation – Frank Fischer - RC comment
G.3 REST (OpenAPI) Mapping

The NamespaceUris and ServerUris are still in the schema even though they are no longer needed
as URIs are now always transfered as URIs.

The HTTP mechanism for localization is the Accept-Language header, it should be used instead of
sending an additional "LocaleIds" array.

The service type is determined by the HTTP request path, so there is no need to send an additional
"ServiceId", especially when it is optional.

With no fields left other than "Body" it doesn't make much sense either and would be much simpler
removing that outer object entirely and have the RequestHeader/ResponseHeader plus service data
directly in the top level object.

TagsNo tags attached.
Commit Version
Fix Due Date

Activities

Randy Armstrong

2024-08-24 00:42

administrator   ~0021617

The ServiceId is needed for the WebSocket mapping where no URL exists.
Change for LocaleIds makes sense.
Preventing us from adding the NamespaceUris back in is a risk.

Matthias Damm

2024-08-26 11:07

developer   ~0021619

This is a comment on the OpenAPI mapping - what is the relation of the OpenAPI mapping to WebSocket?
The proposed changes make the OpenAPI mapping easier since it eliminates a layer that is not needed for a HTTP API

We want to provide a simplified API but on the other side we want to keep all OPC UA features that make it more complex to use.

Issue History

Date Modified Username Field Change
2024-08-21 11:12 Matthias Damm New Issue
2024-08-24 00:42 Randy Armstrong Assigned To => Randy Armstrong
2024-08-24 00:42 Randy Armstrong Status new => feedback
2024-08-24 00:42 Randy Armstrong Note Added: 0021617
2024-08-26 11:07 Matthias Damm Note Added: 0021619
2024-08-26 11:07 Matthias Damm Status feedback => assigned