Azure / Azure/azure-rest-api-specs
uiDefinition placement in Microsoft.Web/LogicAppsManagementClient when not using oAuth
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 424
Description
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
Contributor guide
Research direction
Compare the connectionParameter definitions in the linked 2015-08-01-preview and 2016-06-01 logicAppsManagementClient.json files, focusing on the referenced lines and the placement of uiDefinition. Determine whether the stable specification matches the Azure Portal template, and document or correct the schema so the intended placement is unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100