search

Azure / azure-rest-api-specs

The source for REST API specifications for Microsoft Azure.
MIT License
2.5k stars 4.92k forks source link

uiDefinition placement in Microsoft.Web/LogicAppsManagementClient when not using oAuth #15040

Open DSTAlan opened 3 years ago

DSTAlan commented 3 years ago

If I use the Azure Portal to look at the template for an azure Logic App Custom Connector configured to use an API KEY for security I see something like the following for the connectionParameters

"connectionParameters": {
  "api_key": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "API Key",
      "description": "The API Key for this api",
      "tooltip": "Provide your API Key",
      "constraints": {
        "tabIndex": 2,
        "clearText": false,
        "required": "true"
      }
    }
  }
}

This seems to match the 2015-08-01 preview api spec for a connectionParameter line 620 here which contains both the type and uiDefinition properties.

If I look at the the 2016-06-01 stable spec though, the connectionParameter definition doesn't seem to contain the uiDefinition section, just type and oAuthSettings line 1473 here. If I bury in to the oAuthSettings I can eventually find a child uiDefinition but this isn't at the level shown above that I see when I look at at the template in the Azure Portal.

Am I missing something here? I am trying to create a similar object but only seem to be able to nest the uiDefinition within the oAuthSettings?

Thanks

Alan

ghost commented 2 years ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Azure/azure-logicapps-team.

Issue Details
If I use the Azure Portal to look at the template for an azure Logic App Custom Connector configured to use an API KEY for security I see something like the following for the connectionParameters ``` "connectionParameters": { "api_key": { "type": "securestring", "uiDefinition": { "displayName": "API Key", "description": "The API Key for this api", "tooltip": "Provide your API Key", "constraints": { "tabIndex": 2, "clearText": false, "required": "true" } } } } ``` This seems to match the 2015-08-01 preview api spec for a connectionParameter [line 620 here](https://github.com/Azure/azure-rest-api-specs/blob/91ac14531f0d05b3d6fcf4a817ea0defde59fe63/specification/web/resource-manager/Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json#L620) which contains both the type and uiDefinition properties. If I look at the the 2016-06-01 stable spec though, the connectionParameter definition doesn't seem to contain the uiDefinition section, just type and oAuthSettings [line 1473 here](https://github.com/Azure/azure-rest-api-specs/blob/91ac14531f0d05b3d6fcf4a817ea0defde59fe63/specification/web/resource-manager/Microsoft.Web/stable/2016-06-01/logicAppsManagementClient.json#L1473). If I bury in to the oAuthSettings I can eventually find a child uiDefinition but this isn't at the level shown above that I see when I look at at the template in the Azure Portal. Am I missing something here? I am trying to create a similar object but only seem to be able to nest the uiDefinition within the oAuthSettings? Thanks Alan
Author: DSTAlan
Assignees: leni-msft
Labels: `Logic App`, `Service Attention`, `needs-triage`, `question`
Milestone: -