Azure / Azure/bicep

"View Type Documentation" link in VS Code should link to api version-specific page

Open
#9,956 2 comments 0 reactions 0 assignees View on GitHub
bug good first issue
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 21m
Merged PRs (30d)
79

Description

I used the "View Type Documentation" link which took me to [this page](https://learn.microsoft.com/en-us/azure/templates/microsoft.dbforpostgresql/flexibleservers?tabs=bicep&pivots=deployment-language-bicep) to find that I could add an `authConfig` section to my `Microsoft.DBforPostgreSQL/flexibleServers@2022-01-20-preview`.

However, after provisioning the database, the authentication was not set. I spent at least an hour troubleshooting, only to realize that I was using the wrong API version in the bicep file.

**Describe the solution you'd like**
To help mitigate this issue for others, it would help if the "View Type Documentation" link took me to the page with the version of the API that I have specified in the bicep file.

Then, I would know what's possible for the version I have configured, or if I change to a new version of the API then I will be more likely to remember to update the API version in the bicep file.

Bonus points -
The tip that told me `authConfig` was not supported should provide some additional information and let me know if there are other versions of the API that do support that property.

Contributor guide

Open the contributing guide

Research direction

Start from the VS Code “View Type Documentation” link described in the issue and reproduce it with Microsoft.DBforPostgreSQL/flexibleServers@2022-01-20-preview. Trace how the resource API version is handled when the documentation URL is opened, then verify that the destination matches that version and that the existing guidance still behaves correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
devtools
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.