Credentials types and authentication API needs to be better documented and available in openapi swagger

[vishutyagi000]

Unable to Authenticate to Matrikon OPC Server Simulation Server while calling Browse rest API endpoint.
Calling http://opcpublisher:80/v2/browse/first or http://localhost:80/v2/browse/first.
Successfully hitting the rest API endpoint however got error of invalid user/password.

To Reproduce

1. On an Edge Device(VM) ,Use OPCPublisher version 2.9.3
2. Call http://opcpublisher:80/v2/browse/first or http://localhost:80/v2/browse/first
3. Body Content to pass this post method

{
  "Connection": {
    "Endpoint": {
      "Url": "opc.tcp://OPCSERVERIP:21381/MatrikonOpcUaWrapper",
      "securityMode": "Best",
      "securityPolicy": "http://opcfoundation.org/UA/SecurityPolicy#Basic128Rsa15"
    },
    "user": {
      "type": "UserName",
      "value": {
        "UserName": "testuser",
        "Password": "password"
      }
    }
  },
  "Request": {
    "view": {
      "viewId": "ns=2;s=0:Random.Int1"
    },
    "nodeId": "ns=2;s=0:Random.Int1",
    "direction": "Forward",
    "header": {
      "namespaceFormat": "Uri"
    }
  }
} 

Getting error Username password invalid.

we want to use /v2/browse/first or /v2/browse as per openapi document
https://github.com/Azure/Industrial-IoT/blob/main/docs/opc-publisher/openapi.json

As per documentation https://github.com/Azure/Industrial-IoT/blob/release/2.9.3/docs/opc-publisher/definitions.md#credentialmodel

CredentailModel is like

But in Source code it is like

Here "value" property in user object is not defined in documentation
"user": {
"type": "UserName",
"value": {
"UserName": "testuser",
"Password": "password"
}
}

Not sure how to pass credentials of opc server as this is not described in documentation.

Expected behavior
It should browse the OPC Simulation server.

Screenshots

Desktop (please complete the following information):

• OS: [Ubuntu]
• Version [20.04]
• OPCpublisher version -2.9.3

Additional context
Please share the example request to call http://localhost:80/v2/browse/first or http://localhost:80/v2/browse or any historical data related API.
In continuation with previous clarification needed ,more info can be found on below issue
#2146

[marcschier]

Yes, it is not documented well. Use "user" and "password" instead of "UserName" and "Password" as property strings.

[vishutyagi000]

@marcschier Thank you its working ,is there any way where we can generate these json input for rest endpoints ,will be very helpful.
However thanks for you quick response, should i close this issue?

[marcschier]

I am thinking we want a typed credential model that is reflected in the open API definition plus some documentation , so let's keep this open for now