Skip to content
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

Elevation property in request header does not work #2218

Closed
alxy opened this issue May 3, 2024 · 4 comments
Closed

Elevation property in request header does not work #2218

alxy opened this issue May 3, 2024 · 4 comments
Labels
bug Something isn't working
Milestone

Comments

@alxy
Copy link

alxy commented May 3, 2024

Describe the bug

The documentation for the CredentialModel is a bit mis-leading for the end-users when using the configuration API. For example, we were using the NodeRead action, and there are two places where you can give the authentication information. Once in the ConnectionModel (user section) and once in the ReadRequestModel (header.elevation) section. We needed to go through the code to see which of the both is actually being used.

Expected behavior
Maybe add to the docs where the username and password have to be passed for the actual authentication with the server. I would also like to know what this elevation section actually means, as I didnt really find any content on it online.

@marcschier marcschier added the documentation Issue in the documentation label May 5, 2024
@marcschier marcschier added this to the 2.9.8 milestone May 5, 2024
@marcschier marcschier modified the milestones: 2.9.9, 2.9.8 Jun 3, 2024
@marcschier marcschier added bug Something isn't working and removed documentation Issue in the documentation labels Jun 10, 2024
@marcschier
Copy link
Collaborator

The Elevation property in the request header (as well as the locales) were a holdover from OPC Twin (2.8). They allowed an elevation for a particular service call. In 2.9. OPC Publisher supports most of OPC Twin API, but porting the elevation behavior was not done. I will fix this to override the connection information should the header specify elevation (or locales). The recommendation is to use the connection model's User property, then there should not be surprises. Hence no need to update the docs.

@marcschier marcschier changed the title Documentation for CredentialModel Elevation property in request header does not work Jun 10, 2024
@marcschier
Copy link
Collaborator

#2241

@alxy
Copy link
Author

alxy commented Jun 11, 2024

The recommendation is to use the connection model's User property, then there should not be surprises.

I would in this scenario recommend to remove the elevation section entirely from the request payload - or what is the intention/use case to keep it now (except maybe for backwards compatibility)

@marcschier
Copy link
Collaborator

Agreed, but we need it for backcompat (unfortunately).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants